CB-5658 Delete stale snapshot of plugin docs
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/commit/390655dd Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/tree/390655dd Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/diff/390655dd Branch: refs/heads/master Commit: 390655dd5b029230647912fbcc7502dc7f4b1bdd Parents: 520d7be Author: Andrew Grieve <[email protected]> Authored: Tue Dec 17 20:49:39 2013 -0500 Committer: Andrew Grieve <[email protected]> Committed: Tue Dec 17 20:49:39 2013 -0500 ---------------------------------------------------------------------- docs/events.batterycritical.md | 95 --------------------------------- docs/events.batterylow.md | 95 --------------------------------- docs/events.batterystatus.md | 102 ------------------------------------ 3 files changed, 292 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/blob/390655dd/docs/events.batterycritical.md ---------------------------------------------------------------------- diff --git a/docs/events.batterycritical.md b/docs/events.batterycritical.md deleted file mode 100644 index 7d3067b..0000000 --- a/docs/events.batterycritical.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -batterycritical -=========== - -This is an event that fires when a Cordova application detects the battery has reached the critical level threshold. - - window.addEventListener("batterycritical", yourCallbackFunction, false); - -Details -------- - -This event that fires when a Cordova application detects the percentage of battery has reached the critical battery threshold. This value is device specific. - -The batterycritical handler will be called with an object that contains two properties: - -- __level:__ The percentage of battery (0-100). _(Number)_ -- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_ - -Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- iOS -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- Tizen -- Windows Phone 8 - -Quick Example -------------- - - window.addEventListener("batterycritical", onBatteryCritical, false); - - function onBatteryCritical(info) { - // Handle the battery critical event - alert("Battery Level Critical " + info.level + "%\nRecharge Soon!"); - } - -Full Example ------------- - - <!DOCTYPE html> - <html> - <head> - <title>Cordova Battery Critical Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Call onDeviceReady when Cordova is loaded. - // - // At this point, the document has loaded but cordova-x.x.x.js has not. - // When Cordova is loaded and talking with the native device, - // it will call the event `deviceready`. - // - function onLoad() { - document.addEventListener("deviceready", onDeviceReady, false); - } - - // Cordova is loaded and it is now safe to make calls Cordova methods - // - function onDeviceReady() { - window.addEventListener("batterycritical", onBatteryCritical, false); - } - - // Handle the batterycritical event - // - function onBatteryCritical(info) { - alert("Battery Level Critical " + info.level + "%\nRecharge Soon!"); - } - - </script> - </head> - <body onload="onLoad()"> - </body> - </html> http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/blob/390655dd/docs/events.batterylow.md ---------------------------------------------------------------------- diff --git a/docs/events.batterylow.md b/docs/events.batterylow.md deleted file mode 100644 index 7718845..0000000 --- a/docs/events.batterylow.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -batterylow -=========== - -This is an event that fires when a Cordova application detects the battery has reached the low level threshold. - - window.addEventListener("batterylow", yourCallbackFunction, false); - -Details -------- - -This event that fires when a Cordova application detects the percentage of battery has reached the low battery threshold. This value is device specific. - -The batterylow handler will be called with an object that contains two properties: - -- __level:__ The percentage of battery (0-100). _(Number)_ -- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_ - -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- iOS -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- Tizen -- Windows Phone 8 - -Quick Example -------------- - - window.addEventListener("batterylow", onBatteryLow, false); - - function onBatteryLow(info) { - // Handle the battery low event - alert("Battery Level Low " + info.level + "%"); - } - -Full Example ------------- - - <!DOCTYPE html> - <html> - <head> - <title>Cordova Device Ready Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Call onDeviceReady when Cordova is loaded. - // - // At this point, the document has loaded but cordova-x.x.x.js has not. - // When Cordova is loaded and talking with the native device, - // it will call the event `deviceready`. - // - function onLoad() { - document.addEventListener("deviceready", onDeviceReady, false); - } - - // Cordova is loaded and it is now safe to make calls Cordova methods - // - function onDeviceReady() { - window.addEventListener("batterylow", onBatteryLow, false); - } - - // Handle the batterylow event - // - function onBatteryLow(info) { - alert("Battery Level Low " + info.level + "%"); - } - - </script> - </head> - <body onload="onLoad()"> - </body> - </html> http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/blob/390655dd/docs/events.batterystatus.md ---------------------------------------------------------------------- diff --git a/docs/events.batterystatus.md b/docs/events.batterystatus.md deleted file mode 100644 index df7e307..0000000 --- a/docs/events.batterystatus.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -batterystatus -=========== - -This is an event that fires when a Cordova application detects a change in the battery status. - - window.addEventListener("batterystatus", yourCallbackFunction, false); - -Details -------- - -This event that fires when a Cordova application detects the percentage of battery has changed by at least 1 percent. It is also fired if the device has been plugged in or un-plugged. - -The battery status handler will be called with an object that contains two properties: - -- __level:__ The percentage of battery (0-100). _(Number)_ -- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_ - -Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event. - -Supported Platforms -------------------- - -- iOS -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- Windows Phone 7 and 8 -- Tizen - -Windows Phone 7 Quirks ----------------------- - -The `level` property is unavailable as Windows Phone 7 does not provide -native APIs for determining battery level. The level value returned on Windows Phone 7 devices will always be -1. -The `isPlugged` parameter _is_ supported. - -Quick Example -------------- - - window.addEventListener("batterystatus", onBatteryStatus, false); - - function onBatteryStatus(info) { - // Handle the online event - console.log("Level: " + info.level + " isPlugged: " + info.isPlugged); - } - -Full Example ------------- - - <!DOCTYPE html> - <html> - <head> - <title>Cordova Device Ready Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Call onDeviceReady when Cordova is loaded. - // - // At this point, the document has loaded but cordova-x.x.x.js has not. - // When Cordova is loaded and talking with the native device, - // it will call the event `deviceready`. - // - function onLoad() { - document.addEventListener("deviceready", onDeviceReady, false); - } - - // Cordova is loaded and it is now safe to make calls Cordova methods - // - function onDeviceReady() { - window.addEventListener("batterystatus", onBatteryStatus, false); - } - - // Handle the batterystatus event - // - function onBatteryStatus(info) { - console.log("Level: " + info.level + " isPlugged: " + info.isPlugged); - } - - </script> - </head> - <body onload="onLoad()"> - </body> - </html>
