• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.power (系统电源管理)
2
3该模块主要提供重启、关机、查询屏幕状态等接口。
4
5> **说明:**
6>
7> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9## 导入模块
10
11```js
12import power from '@ohos.power';
13```
14
15## power.isActive<sup>9+</sup>
16
17isActive(): boolean
18
19检测当前设备是否处于活动状态。有屏的设备为亮屏状态,无屏的设备为非休眠状态。
20
21**系统能力:** SystemCapability.PowerManager.PowerManager.Core
22
23**错误码:**
24
25以下错误码的详细介绍请参见[系统电源管理错误码](errorcode-power.md)。
26
27| 错误码ID   | 错误信息    |
28|---------|---------|
29| 4900101 | If connecting to the service failed. |
30
31**示例:**
32
33```js
34try {
35    let isActive = power.isActive();
36    console.info('power is active: ' + isActive);
37} catch(err) {
38    console.error('check active status failed, err: ' + err);
39}
40```
41
42## power.getPowerMode<sup>9+</sup>
43
44getPowerMode(): DevicePowerMode
45
46获取当前设备的电源模式。
47
48**系统能力:** SystemCapability.PowerManager.PowerManager.Core
49
50**返回值:**
51
52| 类型                                 | 说明       |
53| ------------------------------------ | ---------- |
54| [DevicePowerMode](#devicepowermode9) | 电源模式。 |
55
56**错误码:**
57
58以下错误码的详细介绍请参见[系统电源管理错误码](errorcode-power.md)。
59
60| 错误码ID   | 错误信息    |
61|---------|---------|
62| 4900101 | If connecting to the service failed. |
63
64**示例:**
65
66```js
67try {
68    let mode = power.getPowerMode();
69    console.info('power mode: ' + mode);
70} catch(err) {
71    console.error('get power mode failed, err: ' + err);
72}
73```
74
75## power.isStandby<sup>10+</sup>
76
77isStandby(): boolean
78
79检测当前设备是否进入待机低功耗续航模式。
80
81**系统能力:** SystemCapability.PowerManager.PowerManager.Core
82
83**返回值:**
84
85| 类型                | 说明                                   |
86| ------------------- | -------------------------------------- |
87| boolean | 进入待机模式返回true,否则返回false。 |
88
89**错误码:**
90
91以下错误码的详细介绍请参见[系统电源管理错误码](errorcode-power.md)。
92
93| 错误码ID   | 错误信息    |
94|---------|---------|
95| 4900101 | If connecting to the service failed. |
96
97**示例:**
98
99```js
100try {
101    let isStandby = power.isStandby();
102    console.info('device is in standby: ' + isStandby);
103} catch(err) {
104    console.error('check isStandby failed, err: ' + err);
105}
106```
107
108## power.rebootDevice<sup>(deprecated)</sup>
109
110rebootDevice(reason: string): void
111
112> **说明:**<br>从API version 7开始支持,从API version 9开始不再维护。建议使用power.reboot (#powerreboot9)替代,替代接口能力仅对系统应用开放。
113
114重启设备。
115
116**需要权限:** ohos.permission.REBOOT 仅对系统应用开放
117
118**系统能力:** SystemCapability.PowerManager.PowerManager.Core
119
120**参数:**
121
122| 参数名    | 类型     | 必填   | 说明    |
123| ------ | ------ | ---- | ----- |
124| reason | string | 是    | 重启原因。 |
125
126**示例:**
127
128```js
129power.rebootDevice('reboot_test');
130```
131
132## power.isScreenOn<sup>(deprecated)</sup>
133
134isScreenOn(callback: AsyncCallback&lt;boolean&gt;): void
135
136> **说明:**<br>从API version 9开始不再维护,建议使用[power.isActive](#powerisactive9)替代。
137
138检测当前设备的亮灭屏状态。使用callback异步回调。
139
140**系统能力:** SystemCapability.PowerManager.PowerManager.Core
141
142**参数:**
143
144| 参数名   | 类型                         | 必填 | 说明                                                         |
145| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
146| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。当检测成功,err为undefined,data为获取到的亮灭屏状态,返回true表示亮屏,返回false表示灭屏;否则为错误对象。 |
147
148**示例:**
149
150```js
151power.isScreenOn((err: Error, data: boolean) => {
152    if (typeof err === 'undefined') {
153        console.info('screen on status is ' + data);
154    } else {
155        console.error('check screen status failed, err: ' + err);
156    }
157})
158```
159
160## power.isScreenOn<sup>(deprecated)</sup>
161
162isScreenOn(): Promise&lt;boolean&gt;
163
164> **说明:**<br>从API version 9开始不再维护,建议使用[power.isActive](#powerisactive9)替代。
165
166检测当前设备的亮灭屏状态。使用Promise异步回调。
167
168**系统能力:** SystemCapability.PowerManager.PowerManager.Core
169
170**返回值:**
171| 类型                   | 说明                                               |
172| ---------------------- | -------------------------------------------------- |
173| Promise&lt;boolean&gt; | Promise对象。返回true表示亮屏;返回false表示灭屏。 |
174
175**示例:**
176
177```js
178power.isScreenOn()
179.then((data: boolean) => {
180    console.info('screen on status is ' + data);
181})
182.catch((err: Error) => {
183    console.error('check screen status failed, err: ' + err);
184})
185```
186
187## DevicePowerMode<sup>9+</sup>
188
189表示电源模式的枚举值。
190
191**系统能力:** SystemCapability.PowerManager.PowerManager.Core
192
193| 名称                    | 值   | 说明                   |
194| ----------------------- | ---- | ---------------------- |
195| MODE_NORMAL             | 600  | 表示标准模式,默认值。 |
196| MODE_POWER_SAVE         | 601  | 表示省电模式。         |
197| MODE_PERFORMANCE        | 602  | 表示性能模式。         |
198| MODE_EXTREME_POWER_SAVE | 603  | 表示超级省电模式。     |
199