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

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

说明：

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

导入模块

import power from '@ohos.power';

power.shutdown

shutdown(reason: string): void

系统关机。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.REBOOT

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

参数：

错误码：

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

示例：

try {
    power.shutdown('shutdown_test');
} catch(err) {
    console.error('shutdown failed, err: ' + err);
}

power.reboot⁹⁺

reboot(reason: string): void

重启设备。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.REBOOT

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

参数：

错误码：

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

示例：

try {
    power.reboot('reboot_test');
} catch(err) {
    console.error('reboot failed, err: ' + err);
}

power.isActive⁹⁺

isActive(): boolean

检测当前设备是否处于活动状态。

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

错误码：

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

示例：

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

power.wakeup⁹⁺

wakeup(detail: string): void

唤醒设备。

系统接口： 此接口为系统接口。

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

参数：

错误码：

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

示例：

try {
    power.wakeup('wakeup_test');
} catch(err) {
    console.error('wakeup failed, err: ' + err);
}

power.suspend⁹⁺

suspend(): void

休眠设备。

系统接口： 此接口为系统接口。

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

错误码：

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

示例：

try {
    power.suspend();
} catch(err) {
    console.error('suspend failed, err: ' + err);
}

power.getPowerMode⁹⁺

getPowerMode(): DevicePowerMode

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

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

返回值：

错误码：

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

示例：

try {
    var mode = power.getPowerMode();
    console.info('power mode: ' + mode);
} catch(err) {
    console.error('get power mode failed, err: ' + err);
}

power.setPowerMode⁹⁺

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

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

系统接口： 此接口为系统接口。

需要权限： ohos.permission.POWER_OPTIMIZATION

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

参数：

错误码：

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

示例：

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);
    }
});

power.setPowerMode⁹⁺

setPowerMode(mode: DevicePowerMode): Promise<void>

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

系统接口： 此接口为系统接口。

需要权限： ohos.permission.POWER_OPTIMIZATION

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

参数：

返回值：

错误码：

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

示例：

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);
});

power.rebootDevice^(deprecated)

rebootDevice(reason: string): void

说明：
从API version 7开始支持，从API version 9开始不再维护。建议使用power.reboot替代，替代接口能力仅对系统应用开放。

重启设备。

需要权限： ohos.permission.REBOOT

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

参数：

示例：

power.rebootDevice('reboot_test');

power.isScreenOn^(deprecated)

isScreenOn(callback: AsyncCallback<boolean>): void

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

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

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

参数：

示例：

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

power.isScreenOn^(deprecated)

isScreenOn(): Promise<boolean>

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

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

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

返回值：

示例：

power.isScreenOn()
.then(data => {
    console.info('screen on status is ' + data);
})
.catch(err => {
    console.error('check screen status failed, err: ' + err);
})

DevicePowerMode⁹⁺

表示电源模式的枚举值。

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