commit | a544d4cda0bc6bc756361f35b600e56004e0cb03 | [log] [tgz] |
---|---|---|
author | Dmitry Blotsky <dmitry.blotsky@gmail.com> | Fri Feb 26 18:32:59 2016 -0800 |
committer | Dmitry Blotsky <dmitry.blotsky@gmail.com> | Wed Mar 02 18:48:51 2016 -0800 |
tree | 935f9f896ac5f364b552c534e2925fad202431fe | |
parent | 367aefb72dae9eff053856f61dad100ec3932f72 [diff] |
CB-10720 Reorganizing and rewording docs.
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:
Applications may use window.addEventListener
to attach an event listener for any of the above events after the deviceready
event fires.
cordova plugin add cordova-plugin-battery-status
All events in this plugin return an object with the following properties:
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.
window.addEventListener("batterystatus", onBatteryStatus, false); function onBatteryStatus(status) { console.log("Level: " + status.level + " isPlugged: " + status.isPlugged); }
Warning: the Android and Fire OS implementations are greedy and prolonged use will drain the device's battery.
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.
The isPlugged
parameter is not supported on Windows Phone 8.1. The level
parameter is supported.
Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific. Returns an object containing battery status.
window.addEventListener("batterylow", onBatteryLow, false); function onBatteryLow(status) { alert("Battery Level Low " + status.level + "%"); }
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.
Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific. Returns an object containing battery status.
window.addEventListener("batterycritical", onBatteryCritical, false); function onBatteryCritical(status) { alert("Battery Level Critical " + status.level + "%\nRecharge Soon!"); }
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.