js-apis-power.md 2.6 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开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
5 6

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

Z
zengyawen 已提交
8 9

## 导入模块
Z
zengyawen 已提交
10

A
aqxyjay 已提交
11
```js
Z
zengyawen 已提交
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

系统关机。

26
此接口为系统接口,三方应用不支持调用。
Z
zengyawen 已提交
27

H
hujun211 已提交
28
**需要权限:** ohos.permission.REBOOT
Z
zengyawen 已提交
29

Z
zengyawen 已提交
30
**参数:**
Z
zengyawen 已提交
31

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

**示例:**

A
aqxyjay 已提交
38
```js
Z
zengyawen 已提交
39 40 41
power.shutdownDevice("shutdown_test");
console.info('power_shutdown_device_test success')
```
Z
zengyawen 已提交
42 43 44 45 46


## power.rebootDevice

rebootDevice(reason: string): void
Z
zengyawen 已提交
47 48 49

重启设备。

H
hujun211 已提交
50
**需要权限:** ohos.permission.REBOOT(重启权限)、ohos.permission.REBOOT_RECOVERY(重启并进入recovery或者updater模式的权限)
Z
zengyawen 已提交
51

Z
zengyawen 已提交
52
**参数:**
Z
zengyawen 已提交
53

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

**示例:**

A
aqxyjay 已提交
60
```js
Z
zengyawen 已提交
61 62 63
power.rebootDevice("reboot_test");
console.info('power_reboot_device_test success')
```
Z
zengyawen 已提交
64

Z
zengyawen 已提交
65 66 67 68

## power.isScreenOn

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

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

Z
zengyawen 已提交
72
**参数:**
Z
zengyawen 已提交
73

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

**示例:**

A
aqxyjay 已提交
80
```js
Z
zengyawen 已提交
81 82 83 84 85 86 87 88
power.isScreenOn((error, screenOn) => {
    if (typeof error === "undefined") {
        console.info('screenOn status is ' + screenOn);
    } else {
        console.log('error: ' + error);
    }
})
```
Z
zengyawen 已提交
89

Z
zengyawen 已提交
90

Z
zengyawen 已提交
91 92 93 94 95
## power.isScreenOn

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

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

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

**示例:**

A
aqxyjay 已提交
104
```js
Z
zengyawen 已提交
105 106 107 108 109 110 111 112
power.isScreenOn()
.then(screenOn => {
    console.info('screenOn status is ' + screenOn);
})
.catch(error => {
    console.log('error: ' + error);
})
```