- Overview
- Create your first app
- Templates for apps
- Platform support
- Android
- Blackberry 10
- iOS
- OS X
- Ubuntu
- Windows
- WP8
- Manage versions and platforms
- Customize icons
- Store data
- Manage privacy
- Manage security
- Whitelisting
- Create a plugin
- Android
- Blackberry 10
- iOS
- Windows
- WP8
- Use Plugman
- Embed Cordova in native apps
- Next Steps
- Config.xml
- Events
- CLI Reference
- Hooks
- Plugin.xml
- Battery Status
- Camera
- Console
- Contacts
- Device
- Device Motion
- Device Orientation
- Dialogs
- File
- File Transfer
- Geolocation
- Globalization
- Inappbrowser
- Media
- Media Capture
- Network Information
- Splashscreen
- Vibration
- Statusbar
- Whitelist
- Legacy Whitelist
Android 4.4 | Android 5.1 | Android 6.0 | iOS 9.3 | iOS 10.0 | Windows 10 Store | Travis CI |
---|---|---|---|---|---|---|
cordova-plugin-battery-status
This plugin provides an implementation of an old version of the Battery Status Events API. It adds the following three events to the window
object:
- batterystatus
- batterycritical
- batterylow
Applications may use window.addEventListener
to attach an event listener for any of the above events after the deviceready
event fires.
Installation
cordova plugin add cordova-plugin-battery-status
Status object
All events in this plugin return an object with the following properties:
- level: The battery charge percentage (0-100). (Number)
- isPlugged: A boolean that indicates whether the device is plugged in. (Boolean)
batterystatus event
Fires when the battery charge percentage changes by at least 1 percent, or when the device is plugged in or unplugged. Returns an object containing battery status.
Example
window.addEventListener("batterystatus", onBatteryStatus, false);
function onBatteryStatus(status) {
console.log("Level: " + status.level + " isPlugged: " + status.isPlugged);
}
Supported Platforms
- Amazon Fire OS
- iOS
- Android
- BlackBerry 10
- Windows Phone 7 and 8
- Windows (Windows Phone 8.1 and Windows 10)
- Firefox OS
- Browser (Chrome, Firefox, Opera)
Quirks: Android & Amazon Fire OS
Warning: the Android and Fire OS implementations are greedy and prolonged use will drain the device's battery.
Quirks: Windows Phone 7 & Windows Phone 8
The level
property is not supported on Windows Phone 7 because the OS does not provide native APIs to determine battery level. The isPlugged
parameter is supported.
Quirks: Windows Phone 8.1
The isPlugged
parameter is not supported on Windows Phone 8.1. The level
parameter is supported.
batterylow event
Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific. Returns an object containing battery status.
Example
window.addEventListener("batterylow", onBatteryLow, false);
function onBatteryLow(status) {
alert("Battery Level Low " + status.level + "%");
}
Supported Platforms
- Amazon Fire OS
- iOS
- Android
- BlackBerry 10
- Firefox OS
- Windows (Windows Phone 8.1 and Windows 10)
- Browser (Chrome, Firefox, Opera)
Quirks: Windows Phone 8.1
The batterylow
event fires on Windows Phone 8.1 irrespective of whether the device is plugged in or not. This happens because the OS does not provide an API to detect whether the device is plugged in.
batterycritical event
Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific. Returns an object containing battery status.
Example
window.addEventListener("batterycritical", onBatteryCritical, false);
function onBatteryCritical(status) {
alert("Battery Level Critical " + status.level + "%\nRecharge Soon!");
}
Supported Platforms
- Amazon Fire OS
- iOS
- Android
- BlackBerry 10
- Firefox OS
- Windows (Windows Phone 8.1 and Windows 10)
- Browser (Chrome, Firefox, Opera)
Quirks: Windows Phone 8.1
The batterycritical
event fires on Windows Phone 8.1 irrespective of whether the device is plugged in or not. This happens because the OS does not provide an API to detect whether the device is plugged in.