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

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

说明：

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

当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.power (系统电源管理)。

导入模块

import {power} from '@kit.BasicServicesKit';

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.wakeup⁹⁺

wakeup(detail: string): void

唤醒设备。

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

需要权限： ohos.permission.POWER_MANAGER

API version 9-18，使用该接口无需权限；从API version 19开始，需要申请“ohos.permission.POWER_MANAGER”权限。

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

参数：

错误码：

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

示例：

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

power.suspend⁹⁺

suspend(isImmediate?: boolean): void

休眠设备。

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

需要权限： ohos.permission.POWER_MANAGER

API version 9-18，使用该接口无需权限；从API version 19开始，需要申请“ohos.permission.POWER_MANAGER”权限。

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

参数：

错误码：

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

示例：

try {
    power.suspend();
} catch(err) {
    console.error('suspend 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: Error) => {
    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 : Error)=> {
    console.error('set power mode failed, err: ' + err);
});

power.setScreenOffTime¹²⁺

setScreenOffTime(timeout: number): void

设置熄屏超时时间。

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

需要权限： ohos.permission.POWER_MANAGER

API version 12-18，使用该接口无需权限；从API version 19开始，需要申请“ohos.permission.POWER_MANAGER”权限。

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

参数：

错误码：

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

示例：

try {
    power.setScreenOffTime(30000);
} catch(err) {
    console.error('set screen off time failed, err: ' + err);
}

power.hibernate¹²⁺

hibernate(clearMemory: boolean): void

休眠设备。

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

需要权限： ohos.permission.POWER_MANAGER

API version 12-18，使用该接口无需权限；从API version 19开始，需要申请“ohos.permission.POWER_MANAGER”权限。

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

参数：

错误码：

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

示例：

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

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Basic Services Kit（基础服务）

harmony 鸿蒙DeviceInfo

harmony 鸿蒙OH_Print

harmony 鸿蒙Print_Margin

harmony 鸿蒙Print_PageSize

harmony 鸿蒙Print_PrintAttributes

harmony 鸿蒙Print_PrintDocCallback

harmony 鸿蒙Print_Range

harmony 鸿蒙TimeService

harmony 鸿蒙ohscan.h