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