commit | 29d23daa7e1e0c505de9614a646d41a930c5ae4b | [log] [tgz] |
---|---|---|
author | Steve Gill <stevengill97@gmail.com> | Tue Mar 31 16:05:59 2015 -0700 |
committer | Steve Gill <stevengill97@gmail.com> | Tue Mar 31 16:05:59 2015 -0700 |
tree | 6f0d13987331408bff1e0f0b8e663b9eb4887f54 | |
parent | 6262017475c263e5806323f66227d3ebc62700f8 [diff] |
CB-8653 properly updated translated docs to use new id
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.
Windows Phone 8.1 does not support isPlugged
parameter. The level
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.
Windows Phone 8.1 will fire batterycritical
event regardless of plugged state as it is not supported.
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.
Windows Phone 8.1 will fire batterylow
event regardless of plugged state as it is not supported.
window.addEventListener("batterylow", onBatteryLow, false); function onBatteryLow(info) { // Handle the battery low event alert("Battery Level Low " + info.level + "%"); }