batterycritical

This is an event that fires when a PhoneGap application detects the battery has reached the critical level threshold.

window.addEventListener("batterycritical", yourCallbackFunction, false);

Details

This event that fires when a PhoneGap 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 PhoneGap 'deviceready' event.

Supported Platforms

  • iOS
  • Android
  • BlackBerry WebWorks (OS 5.0 and higher)

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>PhoneGap Device Ready Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Call onDeviceReady when PhoneGap is loaded.
    //
    // At this point, the document has loaded but cordova-1.5.0.js has not.
    // When PhoneGap is loaded and talking with the native device,
    // it will call the event `deviceready`.
    // 
    function onLoad() {
	    document.addEventListener("deviceready", onDeviceReady, false);
	}

    // PhoneGap is loaded and it is now safe to make calls PhoneGap 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>