batterystatus

このイベントはバッテリーのステータスが変化したことを Cordova アプリケーションが検知したときに呼び出されます。

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

詳細

このイベントはバッテリー残量のパーセンテージが1パーセントでも変化したことを Cordova アプリケーションが検知したときに呼び出されます。 また、デバイスが充電器に接続されたとき、接続が解除されたときも呼び出されます。

battery status ハンドラーは以下の2つのプロパティーを含むオブジェクトを伴って呼び出されます:

  • level: バッテリーのパーセンテージ (0-100) (Number)
  • isPlugged: デバイスが充電器に接続されているかどうかを表します (Boolean)

通常は、 Cordova の 'deviceready' イベントを受け取った後、 window.addEventListener を通じてイベントリスナーをセットします。

サポートされているプラットフォーム

  • iOS
  • Android
  • BlackBerry WebWorks (OS 5.0 以上)
  • Windows Phone 7 (Mango)

Windows Phone 7 に関する注意点

Windows Phone 7 はバッテリー残量を取得するネイティブの API を提供していないため、 level プロパティーは利用できません。 isPlugged パラメーターはサポートされています。

使用例

window.addEventListener("batterystatus", onBatteryStatus, false);

function onBatteryStatus(info) {
    // バッテリーに関する操作を記述
    console.log("残量: " + info.level + " 充電器に接続: " + info.isPlugged);
}

詳細な使用例

<!DOCTYPE html>
<html>
  <head>
    <title>Cordova Device Ready 使用例</title>

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

    // Cordova のロード完了とともに onDeviceReady を呼び出します。
    //
    // この時点では、ドキュメントの読み込みは完了していますが、 cordova-1.8.1.js はまだ完了していません。
    // Cordova のロード完了とともに
    // `deviceready` イベントが呼び出されます。
    //
    function onLoad() {
        document.addEventListener("deviceready", onDeviceReady, false);
    }

    // Cordova 準備完了
    //
    function onDeviceReady() {
        window.addEventListener("batterystatus", onBatteryStatus, false);
    }

    // バッテリーに関する操作を記述
    //
    function onBatteryStatus(info) {
        console.log("残量: " + info.level + " 充電器に接続: " + info.isPlugged);
    }

    </script>
  </head>
  <body onload="onLoad()">
  </body>
</html>