js-apis-power.md 2.2 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

Z
zengyawen 已提交
6 7

## 导入模块
Z
zengyawen 已提交
8 9 10 11 12

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

Z
zengyawen 已提交
13
## 系统能力
Z
zengyawen 已提交
14

Z
zengyawen 已提交
15
SystemCapability.PowerManager.PowerManager
Z
zengyawen 已提交
16 17


Z
zengyawen 已提交
18 19 20
## power.shutdownDevice

shutdownDevice(reason: string): void
Z
zengyawen 已提交
21 22 23

系统关机。

Z
zengyawen 已提交
24 25
需要权限:ohos.permission.SHUTDOWN

Z
zengyawen 已提交
26
**参数:**
Z
zengyawen 已提交
27

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

**示例:**

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


## power.rebootDevice

rebootDevice(reason: string): void
Z
zengyawen 已提交
43 44 45

重启设备。

Z
zengyawen 已提交
46 47
需要权限:ohos.permission.REBOOT(重启权限)、ohos.permission.REBOOT_RECOVERY(重启并进入recovery模式的权限)

Z
zengyawen 已提交
48
**参数:**
Z
zengyawen 已提交
49

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

**示例:**

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

Z
zengyawen 已提交
61 62 63 64

## power.isScreenOn

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

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

Z
zengyawen 已提交
68
**参数:**
Z
zengyawen 已提交
69

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

**示例:**

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

Z
zengyawen 已提交
86

Z
zengyawen 已提交
87 88 89 90 91
## power.isScreenOn

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

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

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

**示例:**

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