@ohos.power (系统电源管理)


@ohos.power (系统电源管理)

该模块主要提供重启、关机、查询屏幕状态等接口。

说明:

本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import power from '@ohos.power';
1

power.shutdown

shutdown(reason: string): void

系统关机。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.REBOOT

系统能力: SystemCapability.PowerManager.PowerManager.Core

参数:

参数名 类型 必填 说明
reason string 关机原因。

错误码:

以下错误码的详细介绍请参见系统电源管理错误码

错误码ID 错误信息
4900101 连接服务失败。

示例:

try {
    power.shutdown('shutdown_test');
} catch(err) {
    console.error('shutdown failed, err: ' + err);
}
1
2
3
4
5

power.reboot9+

reboot(reason: string): void

重启设备。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.REBOOT

系统能力: SystemCapability.PowerManager.PowerManager.Core

参数:

参数名 类型 必填 说明
reason string 重启原因。

错误码:

以下错误码的详细介绍请参见系统电源管理错误码

错误码ID 错误信息
4900101 连接服务失败。

示例:

try {
    power.reboot('reboot_test');
} catch(err) {
    console.error('reboot failed, err: ' + err);
}
1
2
3
4
5

power.isActive9+

isActive(): boolean

检测当前设备是否处于活动状态。有屏的设备为亮屏状态,无屏的设备为非休眠状态。

系统能力: SystemCapability.PowerManager.PowerManager.Core

错误码:

以下错误码的详细介绍请参见系统电源管理错误码

错误码ID 错误信息
4900101 连接服务失败。

示例:

try {
    var isActive = power.isActive();
    console.info('power is active: ' + isActive);
} catch(err) {
    console.error('check active status failed, err: ' + err);
}
1
2
3
4
5
6

power.wakeup9+

wakeup(detail: string): void

唤醒设备。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.PowerManager.PowerManager.Core

参数:

参数名 类型 必填 说明
detail string 唤醒原因。

错误码:

以下错误码的详细介绍请参见系统电源管理错误码

错误码ID 错误信息
4900101 连接服务失败。

示例:

try {
    power.wakeup('wakeup_test');
} catch(err) {
    console.error('wakeup failed, err: ' + err);
}
1
2
3
4
5

power.suspend9+

suspend(): void

休眠设备。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.PowerManager.PowerManager.Core

错误码:

以下错误码的详细介绍请参见系统电源管理错误码

错误码ID 错误信息
4900101 连接服务失败。

示例:

try {
    power.suspend();
} catch(err) {
    console.error('suspend failed, err: ' + err);
}
1
2
3
4
5

power.getPowerMode9+

getPowerMode(): DevicePowerMode

获取当前设备的电源模式。

系统能力: SystemCapability.PowerManager.PowerManager.Core

返回值:

类型 说明
DevicePowerMode 电源模式。

错误码:

以下错误码的详细介绍请参见系统电源管理错误码

错误码ID 错误信息
4900101 连接服务失败。

示例:

try {
    var mode = power.getPowerMode();
    console.info('power mode: ' + mode);
} catch(err) {
    console.error('get power mode failed, err: ' + err);
}
1
2
3
4
5
6

power.setPowerMode9+

setPowerMode(mode: DevicePowerMode, callback: AsyncCallback<void>): void

设置当前设备的电源模式。使用callback异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.POWER_OPTIMIZATION

系统能力: SystemCapability.PowerManager.PowerManager.Core

参数:

参数名 类型 必填 说明
mode DevicePowerMode 电源模式。
callback AsyncCallback<void> 回调函数。当设置电源模式成功,err为undefined,否则为错误对象。

错误码:

以下错误码的详细介绍请参见系统电源管理错误码

错误码ID 错误信息
4900101 连接服务失败。

示例:

power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE, err => {
    if (typeof err === 'undefined') {
        console.info('set power mode to MODE_PERFORMANCE');
    } else {
        console.error('set power mode failed, err: ' + err);
    }
});
1
2
3
4
5
6
7

power.setPowerMode9+

setPowerMode(mode: DevicePowerMode): Promise<void>

设置当前设备的电源模式。使用Promise异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.POWER_OPTIMIZATION

系统能力: SystemCapability.PowerManager.PowerManager.Core

参数:

参数名 类型 必填 说明
mode DevicePowerMode 电源模式。

返回值:

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。

错误码:

以下错误码的详细介绍请参见系统电源管理错误码

错误码ID 错误信息
4900101 链接服务失败。

示例:

power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE)
.then(() => {
    console.info('set power mode to MODE_PERFORMANCE');
})
.catch(err => {
    console.error('set power mode failed, err: ' + err);
});
1
2
3
4
5
6
7

power.rebootDevice(deprecated)

rebootDevice(reason: string): void

从API version 9开始不再维护,建议使用power.reboot替代。

重启设备。

需要权限: ohos.permission.REBOOT

系统能力: SystemCapability.PowerManager.PowerManager.Core

参数:

参数名 类型 必填 说明
reason string 重启原因。

示例:

power.rebootDevice('reboot_test');
1

power.isScreenOn(deprecated)

isScreenOn(callback: AsyncCallback<boolean>): void

从API version 9开始不再维护,建议使用power.isActive替代。

检测当前设备的亮灭屏状态。使用callback异步回调。

系统能力: SystemCapability.PowerManager.PowerManager.Core

参数:

参数名 类型 必填 说明
callback AsyncCallback<boolean> 回调函数。当检测成功,err为undefined,data为获取到的亮灭屏状态,返回true表示梁平,返回false表示灭屏;否则为错误对象。

示例:

power.isScreenOn((err, data) => {
    if (typeof err === 'undefined') {
        console.info('screen on status is ' + data);
    } else {
        console.error('check screen status failed, err: ' + err);
    }
})
1
2
3
4
5
6
7

power.isScreenOn(deprecated)

isScreenOn(): Promise<boolean>

从API version 9开始不再维护,建议使用power.isActive替代。

检测当前设备的亮灭屏状态。使用Promise异步回调。

系统能力: SystemCapability.PowerManager.PowerManager.Core

返回值:

类型 说明
Promise<boolean> Promise对象。返回true表示亮屏;返回false表示灭屏。

示例:

power.isScreenOn()
.then(data => {
    console.info('screen on status is ' + data);
})
.catch(err => {
    console.error('check screen status failed, err: ' + err);
})
1
2
3
4
5
6
7

DevicePowerMode9+

表示电源模式的枚举值。

系统能力: SystemCapability.PowerManager.PowerManager.Core

名称 说明
MODE_NORMAL 600 表示标准模式,默认值。
MODE_POWER_SAVE 601 表示省电模式。
MODE_PERFORMANCE 602 表示性能模式。
MODE_EXTREME_POWER_SAVE 603 表示超级省电模式。