提交 fd9c6d50 编写于 作者: H hujun211

modify docs of powermanger

Signed-off-by: Nhujun211 <hujun211@huawei.com>
上级 c0f961d3
......@@ -2,6 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 该模块主要提供电池状态和充放电状态的查询接口。
## 导入模块
......@@ -12,14 +14,14 @@ import batteryInfo from '@ohos.batteryInfo';
## 系统能力
SystemCapability.PowerManager.BatteryManager
SystemCapability.PowerManager.BatteryManager.Core
## 属性
描述电池信息。
| 名称 | 类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ----------------------------- | ---------------------------------------- | ---- | ---- | --------------------- |
| batterySOC | number | 是 | 否 | 表示当前设备剩余电池电量百分比。 |
| chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 否 | 表示当前设备电池的充电状态。 |
| healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 否 | 表示当前设备电池的健康状态。 |
......@@ -42,7 +44,7 @@ SystemCapability.PowerManager.BatteryManager
| 名称 | 默认值 | 描述 |
| -------- | -------- | -------- |
| -------- | ---- | ----------------- |
| NONE | 0 | 表示连接充电器类型未知。 |
| AC | 1 | 表示连接的充电器类型为交流充电器。 |
| USB | 2 | 表示连接的充电器类型为USB。 |
......@@ -55,7 +57,7 @@ SystemCapability.PowerManager.BatteryManager
| 名称 | 默认值 | 描述 |
| -------- | -------- | -------- |
| ------- | ---- | --------------- |
| NONE | 0 | 表示电池充电状态未知。 |
| ENABLE | 1 | 表示电池充电状态为使能状态。 |
| DISABLE | 2 | 表示电池充电状态为停止状态。 |
......@@ -68,7 +70,7 @@ SystemCapability.PowerManager.BatteryManager
| 名称 | 默认值 | 描述 |
| -------- | -------- | -------- |
| ----------- | ---- | -------------- |
| UNKNOWN | 0 | 表示电池健康状态未知。 |
| GOOD | 1 | 表示电池健康状态为正常。 |
| OVERHEAT | 2 | 表示电池健康状态为过热。 |
......
......@@ -2,6 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 该模块提供屏幕亮度的设置接口。
## 导入模块
......@@ -22,7 +24,7 @@ setValue(value: number)
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ----- | ------ | ---- | ----------- |
| value | number | 是 | 亮度的值(0~255) |
- 示例:
......
......@@ -2,6 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 该模块主要提供重启、关机、查询屏幕状态等接口。
## 导入模块
......@@ -12,7 +14,7 @@ import power from '@ohos.power';
## 系统能力
SystemCapability.PowerManager.PowerManager
SystemCapability.PowerManager.PowerManager.Core
## power.shutdownDevice
......@@ -26,7 +28,7 @@ shutdownDevice(reason: string): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | ----- |
| reason | string | 是 | 关机原因。 |
**示例:**
......@@ -43,12 +45,12 @@ rebootDevice(reason: string): void
重启设备。
需要权限:ohos.permission.REBOOT(重启权限)、ohos.permission.REBOOT_RECOVERY(重启并进入recovery模式的权限)
需要权限:ohos.permission.REBOOT(重启权限)、ohos.permission.REBOOT_UPDATER(重启并进入updater模式的权限)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | ----- |
| reason | string | 是 | 重启原因。 |
**示例:**
......@@ -68,7 +70,7 @@ isScreenOn(callback: AsyncCallback&lt;boolean&gt;): void
**参数:**
| 类型 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 指定的callback回调方法,用于获取返回值。<br/>callback返回值:亮屏返回true,灭屏返回false。 |
**示例:**
......@@ -92,7 +94,7 @@ isScreenOn(): Promise&lt;boolean&gt;
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| ---------------------- | --------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例,用于异步获取返回值,亮屏返回true,灭屏返回false。 |
**示例:**
......
......@@ -2,6 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 该模块主要提供Runninglock锁相关操作的接口,包括创建、查询、持锁、释放锁等操作。
## 导入模块
......@@ -13,7 +15,7 @@ import runninglock from '@ohos.runningLock';
## 系统能力
SystemCapability.PowerManager.PowerManager
SystemCapability.PowerManager.PowerManager.Core
## RunningLockType
......@@ -21,7 +23,7 @@ SystemCapability.PowerManager.PowerManager
RunningLock锁的类型。
| 名称 | 默认值 | 描述 |
| -------- | -------- | -------- |
| ------------------------ | ---- | ------------------- |
| BACKGROUND | 1 | 阻止系统休眠的锁。 |
| PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 |
......@@ -35,7 +37,7 @@ isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback&lt;boo
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------- | ---- | ---------------------------------------- |
| type | RunningLockType | 是 | 需要查询的锁的类型。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 指定的callback回调方法,用于获取返回值。<br/>callback返回值:支持返回true,不支持返回false。 |
......@@ -61,13 +63,13 @@ isRunningLockTypeSupported(type: RunningLockType): Promise&lt;boolean&gt;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---- | --------------- | ---- | ---------- |
| type | RunningLockType | 是 | 需要查询的锁的类型。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| ---------------------- | ---------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例,用于异步获取返回值,支持返回true,不支持返回false。 |
**示例:**
......@@ -94,7 +96,7 @@ createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback&l
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| name | string | 是 | 锁的名字。 |
| type | RunningLockType | 是 | 要创建的锁的类型。 |
| callback | AsyncCallback&lt;[RunningLock](#runninglock)&gt; | 是 | 指定的callback回调方法,用于获取返回的RunningLock锁对象。 |
......@@ -127,14 +129,14 @@ createRunningLock(name: string, type: RunningLockType): Promise&lt;RunningLock&g
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---- | --------------- | ---- | --------- |
| name | string | 是 | 锁的名字。 |
| type | RunningLockType | 是 | 要创建的锁的类型。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| ---------------------------------------- | ---------------------------------- |
| Promise&lt;[RunningLock](#runninglock)&gt; | Promise实例,用于异步获取返回的RunningLock锁对象。 |
**示例:**
......@@ -164,7 +166,7 @@ lock(timeout: number): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------- | ------ | ---- | -------------------- |
| timeout | number | 否 | 锁定和持有RunningLock的时长。 |
**示例:**
......@@ -209,7 +211,7 @@ isUsed(): boolean
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| ------- | ------------------------------------- |
| boolean | 当前RunningLock是持有状态返回true,释放状态返回false。 |
**示例:**
......
......@@ -2,6 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 该模块主要提供设备热状态的监听接口。
## 导入模块
......@@ -16,7 +18,7 @@ import thermal from '@ohos.thermal';
热档位信息。
| 名称 | 默认值 | 描述 |
| -------- | -------- | -------- |
| ---------- | ---- | ---------------------------------------- |
| COOL | 0 | 表明设备处于低温的状态,业务执行不受热控的限制。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager |
| NORMAL | 1 | 表明设备处于正常工作状态,但温度不低,需要注意是否临近发热状态。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager |
| WARM | 2 | 表明设备已经进入温热状态,部分无感知业务需要考虑停止或延迟执行。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager |
......@@ -37,12 +39,13 @@ subscribeThermalLevel(callback: AsyncCallback&lt;ThermalLevel&gt;): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | --------------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback&lt;ThermalLevel&gt; | 是 | 指定的callback回调方法,用于获取返回值。<br/>callback返回值:热档位信息。 |
**示例:**
```
var lev = 0;
thermal.subscribeThermalLevel((lev) => {
console.info("Thermal level is: " + lev);
})
......@@ -59,7 +62,7 @@ unsubscribeThermalLevel(callback?: AsyncCallback<void>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------- | ---- | --------------------- |
| callback | AsyncCallback&lt;void&gt; | 可选 | 指定的callback回调方法,无返回值。 |
**示例:**
......@@ -81,7 +84,7 @@ getThermalLevel(): ThermalLevel
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| ------------ | ------ |
| ThermalLevel | 热档位信息。 |
**示例:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册