mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-02-13 19:29:37 +08:00
80 lines
2.3 KiB
TypeScript
80 lines
2.3 KiB
TypeScript
import { Cordova, CordovaProperty, Plugin } from './plugin';
|
||
import { Observable } from 'rxjs/Observable';
|
||
|
||
|
||
declare var navigator: any;
|
||
|
||
/**
|
||
* @name Network
|
||
* @description
|
||
* Requires Cordova plugin: cordova-plugin-network-information. For more info, please see the [Network plugin docs](https://github.com/apache/cordova-plugin-network-information).
|
||
*
|
||
* @usage
|
||
* ```js
|
||
* import {Network} from 'ionic-native';
|
||
*
|
||
* // watch network for a disconnect
|
||
* let disconnectSubscription = Network.onDisconnect().subscribe(() => {
|
||
* console.log('network was disconnected :-( ')
|
||
* });
|
||
*
|
||
* // stop disconnect watch
|
||
* disconnectSubscription.unsubscribe();
|
||
*
|
||
*
|
||
* // watch network for a connection
|
||
* let connectSubscription = Network.onConnect().subscribe(() => {
|
||
* console.log('network connected!');
*
|
||
* // We just got a connection but we need to wait briefly
|
||
*
// before we determine the connection type. Might need to wait
|
||
* // prior to doing any api requests as well.
|
||
* setTimeout(() => {
|
||
* if (Network.connection === 'wifi') {
|
||
* console.log('we got a wifi connection, woohoo!');
|
||
* }
|
||
* }, 3000);
|
||
* });
|
||
*
|
||
* // stop connect watch
|
||
* connectSubscription.unsubscribe();
|
||
*
|
||
* ```
|
||
* @advanced
|
||
* The `connection` property will return one of the following connection types: `unknown`, `ethernet`, `wifi`, `2g`, `3g`, `4g`, `cellular`, `none`
|
||
*/
|
||
@Plugin({
|
||
plugin: 'cordova-plugin-network-information',
|
||
repo: 'https://github.com/apache/cordova-plugin-network-information',
|
||
platforms: ['Amazon Fire OS', 'iOS', 'Android', 'BlackBerry 10', 'Windows Phone 7', 'Windows Phone 8', 'Windows', 'Firefox OS', 'Browser'],
|
||
pluginRef: 'navigator.connection'
|
||
})
|
||
export class Network {
|
||
|
||
/**
|
||
* Return the network connection type
|
||
*/
|
||
@CordovaProperty
|
||
static get connection(): String { return navigator.connection.type; }
|
||
|
||
/**
|
||
* Get notified when the device goes offline
|
||
* @returns {Observable<any>} Returns an observable.
|
||
*/
|
||
@Cordova({
|
||
eventObservable: true,
|
||
event: 'offline'
|
||
})
|
||
static onDisconnect(): Observable<any> { return; }
|
||
|
||
/**
|
||
* Get notified when the device goes online
|
||
* @returns {Observable<any>} Returns an observable.
|
||
*/
|
||
@Cordova({
|
||
eventObservable: true,
|
||
event: 'online'
|
||
})
|
||
static onConnect(): Observable<any> { return; }
|
||
|
||
}
|