mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-02-13 19:29:37 +08:00
77 lines
1.9 KiB
TypeScript
77 lines
1.9 KiB
TypeScript
import {Plugin, Cordova} from './plugin';
|
|
import {Observable} from 'rxjs/Observable';
|
|
|
|
/**
|
|
* @name Battery Status
|
|
* @description
|
|
* Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see the [BatteryStatus plugin docs](https://github.com/apache/cordova-plugin-battery-status).
|
|
*
|
|
* @usage
|
|
* ```js
|
|
* import {BatteryStatus} from 'ionic-native';
|
|
*
|
|
*
|
|
*
|
|
* // watch change in battery status
|
|
* let subscription = BatteryStatus.onChange().subscribe(
|
|
* status => {
|
|
* console.log(status.level, status.isPlugged);
|
|
* }
|
|
* );
|
|
*
|
|
* // stop watch
|
|
* subscription.unsubscribe();
|
|
*
|
|
* ```
|
|
*/
|
|
@Plugin({
|
|
plugin: 'cordova-plugin-battery-status',
|
|
repo: 'https://github.com/apache/cordova-plugin-battery-status',
|
|
platforms: ['Amazon Fire OS', 'iOS', 'Android', 'BlackBerry 10', 'Windows Phone 7', 'Windows Phone 8', 'Windows', 'Firefox OS', 'Browser']
|
|
})
|
|
export class BatteryStatus {
|
|
|
|
/**
|
|
* Watch the change in battery level
|
|
* @returns {Observable} Returns an observable that pushes a status object
|
|
*/
|
|
@Cordova({
|
|
eventObservable: true,
|
|
event: 'batterystatus'
|
|
})
|
|
static onChange (): Observable<StatusObject> {return; }
|
|
|
|
/**
|
|
* Watch when the battery level goes low
|
|
* @returns {Observable<StatusObject>} Returns an observable that pushes a status object
|
|
*/
|
|
@Cordova({
|
|
eventObservable: true,
|
|
event: 'batterylow'
|
|
})
|
|
static onLow (): Observable<StatusObject> {return; }
|
|
|
|
/**
|
|
* Watch when the battery level goes to critial
|
|
* @returns {Observable<StatusObject>} Returns an observable that pushes a status object
|
|
*/
|
|
@Cordova({
|
|
eventObservable: true,
|
|
event: 'batterycritical'
|
|
})
|
|
static onCritical (): Observable<StatusObject> {return; }
|
|
|
|
}
|
|
|
|
export interface StatusObject {
|
|
/**
|
|
* The battery charge percentage
|
|
*/
|
|
level: number;
|
|
|
|
/**
|
|
* A boolean that indicates whether the device is plugged in
|
|
*/
|
|
isPlugged: boolean;
|
|
}
|