# Battery プラグイン

テスト環境 ( バージョン番号 ) : [2.0.3](https://github.com/apache/cordova-plugin-battery-status/releases/tag/2.0.3)

このプラグインの詳細は、[こちらの原文 ( GitHub )](https://github.com/apache/cordova-plugin-battery-status) をご確認ください。

## プラグイン ID

```
cordova-plugin-battery-status
```

## プラグインの追加方法 ( Monaca 上での操作 )

このプラグインを使用する場合には、Monaca クラウド IDE の \[ Cordova プラグインの管理 ] 上で、\
`Battery` プラグインを[有効](https://ja.docs.monaca.io/products_guide/monaca_ide/dependencies/cordova_plugin#cordova-puraguin-noinpto)にします。

## API の解説

### ステータス オブジェクト

このプラグインのすべてのイベントは、次のプロパティを持つオブジェクトを返します。

| プロパティ       | 型   | 解説                 |
| ----------- | --- | ------------------ |
| `level`     | 数値  | バッテリー充電率 (`0-100`) |
| `isPlugged` | 真偽値 | 端末が充電中かを示す真偽値      |

### batterystatus イベント

バッテリの充電率が少なくとも1パーセント変化したとき、または端末の充電を開始、または停止されたときに発火します。\
バッテリーの状態を含む [object](#suttasu-obujekuto) を返します。

#### Example

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

function onBatteryStatus(status) {
    console.log("Level: " + status.level + " isPlugged: " + status.isPlugged);
}
```

#### Android 特有の動作

{% hint style="info" %}
Android の組み合わせは、バッテリーを多く消費するため、長時間の使用には注意が必要です。
{% endhint %}

### batterylow イベント

バッテリー残量が非常に少なくなった場合に、このイベントが発火します。しきい値は、端末によって異なります。\
バッテリーの状態を示すプロパティが格納された [object](#suttasu-obujekuto) を返します。

#### Example

```javascript
window.addEventListener("batterylow", onBatteryLow, false);

function onBatteryLow(status) {
    alert("Battery Level Low " + status.level + "%");
}
```

### batterycritical イベント

バッテリー充電率が臨界充電しきい値に達した場合に、このイベントが発火します。しきい値は、端末によって異なります。\
バッテリーの状態を示すプロパティが格納された [object](https://ja.docs.monaca.io/reference/cordova_9.0/battery-status#suttasu-obujekuto) を返します。

#### Example

```javascript
window.addEventListener("batterycritical", onBatteryCritical, false);

function onBatteryCritical(status) {
    alert("Battery Level Critical " + status.level + "%\nRecharge Soon!");
```