> For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt.

# getBatteryInfo

获取电池信息。

## 扫码预览

![扫码预览 getBatteryInfo](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fget-battery-info%252Findex)

## 使用限制

> \[!WARNING]
> **Android、iOS**：Android 返回 0 到 100，iOS 由系统电量换算后可能返回 0；依赖固定下限的调用方在低电量时可能误判。

## 支持版本

前端库版本不低于 `0.0.25`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>不支持</td></tr>
</tbody>
</table>

## 使用说明

- 电量为瞬时快照，需要持续跟踪省电模式时改用 `onBatteryInfoChange`

## 调用方式

### 异步 API

```typescript
getBatteryInfo(params?: object): Promise<GetBatteryInfoResult>
```

## 入参

无。

## 调用示例

```typescript
import { getBatteryInfo } from '@doubao-dev/framework/api';

const { isCharging, level } = await getBatteryInfo();

console.log(isCharging, level);
```

## 成功返回

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>约束</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>isCharging</code></td><td><code>boolean</code></td><td>是</td><td>-</td><td>是否正在充电。</td></tr>
<tr><td><code>level</code></td><td><code>number</code></td><td>是</td><td>取值范围 0 到 100 的整数</td><td>当前电量百分比。Android、iOS：Android 返回 0 到 100，iOS 由系统电量换算后可能返回 0。</td></tr>
</tbody>
</table>

### 返回示例

```json
{
  "isCharging": false,
  "level": 82
}
```

## 错误处理

错误对象和通用错误码见 [通用错误处理](/apps-plugin/docs/js-api/common-errors.md#错误返回)。

### 错误码

#### 通用错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
</thead>
<tbody>
<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android</td></tr>
</tbody>
</table>
