| commit | c8dc4b93b647cb105039d9758991c99213043430 | [log] [tgz] |
|---|---|---|
| author | Steve Gill <stevengill97@gmail.com> | Fri Mar 13 16:46:53 2015 -0700 |
| committer | Steve Gill <stevengill97@gmail.com> | Fri Mar 13 16:47:03 2015 -0700 |
| tree | d1172acd3f9ce146251b94d30ec458f87866aa45 | |
| parent | 50fd63d192a01fa2b76515714943fda44e67ef1d [diff] |
CB-8653 Updated Readme
This plugin provides an implementation of an old version of the Battery Status Events API.
It adds the following three window events:
cordova plugin add cordova-plugin-battery-status
This event fires when the percentage of battery charge changes by at least 1 percent, or if the device is plugged in or unplugged.
The battery status handler is passed an object that contains two properties:
level: The percentage of battery charge (0-100). (Number)
isPlugged: A boolean that indicates whether the device is plugged in. (Boolean)
Applications typically should use window.addEventListener to attach an event listener after the deviceready event fires.
Windows Phone 7 does not provide native APIs to determine battery level, so the level property is unavailable. The isPlugged parameter is supported.
window.addEventListener("batterystatus", onBatteryStatus, false);
function onBatteryStatus(info) {
// Handle the online event
console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
}
The event fires when the percentage of battery charge has reached the critical battery threshold. The value is device-specific.
The batterycritical handler is passed an object that contains two properties:
level: The percentage of battery charge (0-100). (Number)
isPlugged: A boolean that indicates whether the device is plugged in. (Boolean)
Applications typically should use window.addEventListener to attach an event listener once the deviceready event fires.
window.addEventListener("batterycritical", onBatteryCritical, false);
function onBatteryCritical(info) {
// Handle the battery critical event
alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
}
The event fires when the percentage of battery charge has reached the low battery threshold, device-specific value.
The batterylow handler is passed an object that contains two properties:
level: The percentage of battery charge (0-100). (Number)
isPlugged: A boolean that indicates whether the device is plugged in. (Boolean)
Applications typically should use window.addEventListener to attach an event listener once the deviceready event fires.
window.addEventListener("batterylow", onBatteryLow, false);
function onBatteryLow(info) {
// Handle the battery low event
alert("Battery Level Low " + info.level + "%");
}