该模块主要提供重启、关机、查询屏幕状态等接口。开发者可以使用该模块的接口获取设备的活动状态、电源模式、亮灭屏状态等。
本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
isActive(): boolean
检测当前设备是否处于活动状态。
系统能力: SystemCapability.PowerManager.PowerManager.Core
返回值:
| 类型 | 说明 |
|---|---|
| boolean | 活动状态返回true,非活动状态或获取设备活动状态失败时返回false。 |
示例:
let isActive = power.isActive();
console.info('power is active: ' + isActive); rebootDevice(reason: string): void
重启系统。
从API version 7开始支持,从API version 9开始不再维护,替代接口能力仅对系统应用开放。
需要权限: ohos.permission.REBOOT,该权限仅系统应用可申请。
系统能力: SystemCapability.PowerManager.PowerManager.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| reason | string | 是 | 重启原因。例如,“updater”表示重启后进入更新模式。如果未指定该参数,系统将在重启后进入正常模式。 |
示例:
power.rebootDevice('reboot_test'); getPowerMode(): DevicePowerMode
获取当前设备的电源模式。
系统能力: SystemCapability.PowerManager.PowerManager.Core
返回值:
| 类型 | 说明 |
|---|---|
| DevicePowerMode | 当前设备的电源模式,取值包括标准模式、省电模式、性能模式、超级省电模式等。当获取当前设备的电源模式失败时返回0,该值不在DevicePowerMode枚举定义范围内。开发者应检查返回值是否为有效枚举值(600及以上)。 |
示例:
let mode = power.getPowerMode();
console.info('power mode: ' + mode); isStandby(): boolean
检测当前设备是否进入待机低功耗续航模式。
系统能力: SystemCapability.PowerManager.PowerManager.Core
返回值:
| 类型 | 说明 |
|---|---|
| boolean | 进入待机模式返回true,否则返回false。 |
错误码:
以下错误码的详细介绍请参见系统电源管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 4900101 | Failed to connect to the service. |
示例:
try {
let isStandby = power.isStandby();
console.info('device is in standby: ' + isStandby);
} catch(err) {
console.error('check isStandby failed, err: ' + err);
} isScreenOn(callback: AsyncCallback<boolean>): void
检测当前设备的亮灭屏状态。使用callback异步回调。
系统能力: SystemCapability.PowerManager.PowerManager.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<boolean> | 是 | 回调函数。当检测成功,err为undefined,data为获取到的亮灭屏状态,返回true表示亮屏,返回false表示灭屏;否则为错误对象。 |
示例:
power.isScreenOn((err: Error, data: boolean) => {
if (typeof err === 'undefined') {
console.info('screen on status is ' + data);
} else {
console.error('check screen status failed, err: ' + err);
}
}) isScreenOn(): Promise<boolean>
检测当前设备的亮灭屏状态。使用Promise异步回调。
系统能力: SystemCapability.PowerManager.PowerManager.Core
返回值:
| 类型 | 说明 |
|---|---|
| Promise<boolean> | Promise对象。返回true表示亮屏;返回false表示灭屏。 |
示例:
power.isScreenOn()
.then((data: boolean) => {
console.info('screen on status is ' + data);
})
.catch((err: Error) => {
console.error('check screen status failed, err: ' + err);
})