js-apis-power.md 2.5 KB
Newer Older
Z
zengyawen 已提交
1
# 系统电源管理
Z
zengyawen 已提交
2

Z
zengyawen 已提交
3 4
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
H
hujun211 已提交
5 6
>
> 该模块主要提供重启、关机、查询屏幕状态等接口。
Z
zengyawen 已提交
7

Z
zengyawen 已提交
8 9

## 导入模块
Z
zengyawen 已提交
10 11 12 13 14

```
import power from '@ohos.power';
```

Z
zengyawen 已提交
15
## 系统能力
Z
zengyawen 已提交
16

H
hujun211 已提交
17
SystemCapability.PowerManager.PowerManager.Core
Z
zengyawen 已提交
18 19


Z
zengyawen 已提交
20 21 22
## power.shutdownDevice

shutdownDevice(reason: string): void
Z
zengyawen 已提交
23 24 25

系统关机。

Z
zengyawen 已提交
26 27
需要权限:ohos.permission.SHUTDOWN

Z
zengyawen 已提交
28
**参数:**
Z
zengyawen 已提交
29

H
hujun211 已提交
30 31 32
| 参数名    | 类型     | 必填   | 说明    |
| ------ | ------ | ---- | ----- |
| reason | string | 是    | 关机原因。 |
Z
zengyawen 已提交
33 34 35 36 37 38 39

**示例:**

```
power.shutdownDevice("shutdown_test");
console.info('power_shutdown_device_test success')
```
Z
zengyawen 已提交
40 41 42 43 44


## power.rebootDevice

rebootDevice(reason: string): void
Z
zengyawen 已提交
45 46 47

重启设备。

H
hujun211 已提交
48
需要权限:ohos.permission.REBOOT(重启权限)、ohos.permission.REBOOT_UPDATER(重启并进入updater模式的权限)
Z
zengyawen 已提交
49

Z
zengyawen 已提交
50
**参数:**
Z
zengyawen 已提交
51

H
hujun211 已提交
52 53 54
| 参数名    | 类型     | 必填   | 说明    |
| ------ | ------ | ---- | ----- |
| reason | string | 是    | 重启原因。 |
Z
zengyawen 已提交
55 56 57 58 59 60 61

**示例:**

```
power.rebootDevice("reboot_test");
console.info('power_reboot_device_test success')
```
Z
zengyawen 已提交
62

Z
zengyawen 已提交
63 64 65 66

## power.isScreenOn

isScreenOn(callback: AsyncCallback<boolean>): void
Z
zengyawen 已提交
67 68 69

检测当前设备的亮灭屏状态。

Z
zengyawen 已提交
70
**参数:**
Z
zengyawen 已提交
71

H
hujun211 已提交
72 73 74
| 类型       | 类型                           | 必填   | 说明                                       |
| -------- | ---------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是    | 指定的callback回调方法,用于获取返回值。<br/>callback返回值:亮屏返回true,灭屏返回false。 |
Z
zengyawen 已提交
75 76 77 78 79 80 81 82 83 84 85 86

**示例:**

```
power.isScreenOn((error, screenOn) => {
    if (typeof error === "undefined") {
        console.info('screenOn status is ' + screenOn);
    } else {
        console.log('error: ' + error);
    }
})
```
Z
zengyawen 已提交
87

Z
zengyawen 已提交
88

Z
zengyawen 已提交
89 90 91 92 93
## power.isScreenOn

isScreenOn(): Promise&lt;boolean&gt;

检测当前设备的亮灭屏状态。
Z
zengyawen 已提交
94

Z
zengyawen 已提交
95
**返回值:**
H
hujun211 已提交
96 97
| 类型                     | 说明                                      |
| ---------------------- | --------------------------------------- |
Z
zengyawen 已提交
98 99 100 101 102 103 104 105 106 107 108 109 110
| Promise&lt;boolean&gt; | Promise实例,用于异步获取返回值,亮屏返回true,灭屏返回false。 |

**示例:**

```
power.isScreenOn()
.then(screenOn => {
    console.info('screenOn status is ' + screenOn);
})
.catch(error => {
    console.log('error: ' + error);
})
```