• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @system.battery (电量信息)
2
3该模块提供充电状态及剩余电量的查询功能。
4
5>  ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
6>  - 从API Version 6开始不再维护,建议使用[`@ohos.batteryInfo`](js-apis-battery-info.md)替代。
7>  - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9
10## 导入模块
11
12
13```js
14import battery from '@system.battery';
15```
16
17
18## battery.getStatus
19
20getStatus(options?: GetStatusOptions): void;
21
22获取设备当前的充电状态及剩余电量。
23
24**系统能力:** SystemCapability.PowerManager.BatteryManager.Core
25
26**参数:**
27
28| 参数名 | 类型 | 必填 | 说明 |
29| -------- | -------- | -------- | -------- |
30| options | [GetStatusOptions](#getstatusoptions) | 否 | 包含接口调用结果的对象。可选,默认为空。 |
31
32**示例:**
33
34```js
35battery.getStatus({
36    success: function(data) {
37        console.log('success get battery level:' + data.level);
38    },
39    fail: function(data, code) {
40        console.error('fail to get battery level code:' + code + ', data: ' + data);
41    }
42});
43```
44
45## GetStatusOptions
46
47包含接口调用结果的对象。
48
49**系统能力:** SystemCapability.PowerManager.BatteryManager.Core
50
51| 参数名   | 类型                                                | 必填 | 说明                                                         |
52| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
53| success  | (data: [BatteryResponse](#batteryresponse)) => void | 否   | 接口调用成功的回调函数,data为[BatteryResponse](#batteryresponse)类型的返回值。 |
54| fail     | (data: string, code: number) => void                | 否   | 接口调用失败的回调函数。data为错误信息,code为错误码。       |
55| complete | () => void                                          | 否   | 接口调用结束的回调函数。                                     |
56
57## BatteryResponse
58
59包含充电状态及剩余电量的对象。
60
61**系统能力:** SystemCapability.PowerManager.BatteryManager.Core
62
63| 参数名 | 类型 | 可读 | 可写 | 说明 |
64| -------- | -------- | -------- | -------- | -------- |
65| charging | boolean | 是 | 否 | 当前电池是否在充电中。 |
66| level | number | 是 | 否 | 当前电池的电量,取值范围:0.00 - 1.00 。 |
67