mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-08-18 05:18:39 +08:00
43 lines
1.0 KiB
TypeScript
43 lines
1.0 KiB
TypeScript
/**
|
|
* Contains connectivity utility methods.
|
|
* @module "connectivity"
|
|
*/ /** */
|
|
|
|
/**
|
|
* Gets the type of connection.
|
|
* Returns a value from the connectivity.connectionType enumeration.
|
|
* To use this method on Android you need to have the android.permission.ACCESS_NETWORK_STATE permission added to the AndroidManifest.xml file.
|
|
*/
|
|
export function getConnectionType(): number;
|
|
|
|
/**
|
|
* Defines the different connection types.
|
|
*/
|
|
export enum connectionType {
|
|
/**
|
|
* Denotes no connection.
|
|
*/
|
|
none = 0,
|
|
|
|
/**
|
|
* Denotes a WiFi connection.
|
|
*/
|
|
wifi = 1,
|
|
|
|
/**
|
|
* Denotes a mobile connection, i.e. cellular network or WAN
|
|
*/
|
|
mobile = 2
|
|
}
|
|
|
|
/**
|
|
* Starts monitoring the connection type.
|
|
* @param connectionChangedCallback A function that will be called when the connection type changes.
|
|
*/
|
|
export function startMonitoring(connectionTypeChangedCallback: (newConnectionType: number) => void): void;
|
|
|
|
/**
|
|
* Stops monitoring the connection type.
|
|
*/
|
|
export function stopMonitoring(): void;
|