| commit | 41d35b743081df52869705f7e665d83b2d50fb6f | [log] [tgz] |
|---|---|---|
| author | Tim Brust <ratchet.player@gmx.de> | Mon Mar 04 15:31:59 2019 +0100 |
| committer | Jan Piotrowski <piotrowski+github@gmail.com> | Mon Mar 04 15:31:59 2019 +0100 |
| tree | 321bcf1cf8e9bbe2d34a1654ee878abfe7e47a7a | |
| parent | 83c6e4476fd66f160bac36e76ae6bb701c580364 [diff] |
feat: update typings (#72) this is part of https://github.com/apache/cordova/issues/39 <!-- Please make sure the checklist boxes are all checked before submitting the PR. The checklist is intended as a quick reference, for complete details please see our Contributor Guidelines: http://cordova.apache.org/contribute/contribute_guidelines.html Thanks! --> ### Platforms affected n/a - development with TypeScript ### Motivation and Context <!-- Why is this change required? What problem does it solve? --> <!-- If it fixes an open issue, please link to the issue here. --> updates typings as discussed in apache/cordova#39 ### Description Updates type definition header, simplifies event types and correctly format the TSDoc. ### Testing Manual testing via development in VSCode. ### Checklist - [ ] I've run the tests to see all new and existing tests pass - [ ] I added automated test coverage as appropriate for this change - [ ] Commit is prefixed with `(platform)` if this change only applies to one platform (e.g. `(android)`) - [ ] If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct [keyword to close issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/)) - [ ] I've updated the documentation if necessary
| AppVeyor | Travis CI |
|---|---|
 |
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 implementation is greedy and prolonged use will drain the device's battery.
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 + "%");
}
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!");
}