提交 fd9c6d50 编写于 作者: H hujun211

modify docs of powermanger

Signed-off-by: Nhujun211 <hujun211@huawei.com>
上级 c0f961d3
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 该模块主要提供电池状态和充放电状态的查询接口。
## 导入模块 ## 导入模块
...@@ -12,22 +14,22 @@ import batteryInfo from '@ohos.batteryInfo'; ...@@ -12,22 +14,22 @@ import batteryInfo from '@ohos.batteryInfo';
## 系统能力 ## 系统能力
SystemCapability.PowerManager.BatteryManager SystemCapability.PowerManager.BatteryManager.Core
## 属性 ## 属性
描述电池信息。 描述电池信息。
| 名称 | 类型 | 可读 | 可写 | 描述 | | 名称 | 类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ----------------------------- | ---------------------------------------- | ---- | ---- | --------------------- |
| batterySOC | number | 是 | 否 | 表示当前设备剩余电池电量百分比。 | | batterySOC | number | 是 | 否 | 表示当前设备剩余电池电量百分比。 |
| chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 否 | 表示当前设备电池的充电状态。 | | chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 否 | 表示当前设备电池的充电状态。 |
| healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 否 | 表示当前设备电池的健康状态。 | | healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 否 | 表示当前设备电池的健康状态。 |
| pluggedType | [BatteryPluggedType](#batterypluggedtype) | 是 | 否 | 表示当前设备连接的充电器类型。 | | pluggedType | [BatteryPluggedType](#batterypluggedtype) | 是 | 否 | 表示当前设备连接的充电器类型。 |
| voltage | number | 是 | 否 | 表示当前设备电池的电压,单位微伏。 | | voltage | number | 是 | 否 | 表示当前设备电池的电压,单位微伏。 |
| technology | string | 是 | 否 | 表示当前设备电池的技术型号。 | | technology | string | 是 | 否 | 表示当前设备电池的技术型号。 |
| batteryTemperature | number | 是 | 否 | 表示当前设备电池的温度,单位0.1摄氏度。 | | batteryTemperature | number | 是 | 否 | 表示当前设备电池的温度,单位0.1摄氏度。 |
| isBatteryPresent<sup>7+</sup> | boolean | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 | | isBatteryPresent<sup>7+</sup> | boolean | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 |
- 示例: - 示例:
``` ```
...@@ -41,12 +43,12 @@ SystemCapability.PowerManager.BatteryManager ...@@ -41,12 +43,12 @@ SystemCapability.PowerManager.BatteryManager
表示连接的充电器类型的枚举。 表示连接的充电器类型的枚举。
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| -------- | -------- | -------- | | -------- | ---- | ----------------- |
| NONE | 0 | 表示连接充电器类型未知。 | | NONE | 0 | 表示连接充电器类型未知。 |
| AC | 1 | 表示连接的充电器类型为交流充电器。 | | AC | 1 | 表示连接的充电器类型为交流充电器。 |
| USB | 2 | 表示连接的充电器类型为USB。 | | USB | 2 | 表示连接的充电器类型为USB。 |
| WIRELESS | 3 | 表示连接的充电器类型为无线充电器。 | | WIRELESS | 3 | 表示连接的充电器类型为无线充电器。 |
## BatteryChargeState ## BatteryChargeState
...@@ -54,12 +56,12 @@ SystemCapability.PowerManager.BatteryManager ...@@ -54,12 +56,12 @@ SystemCapability.PowerManager.BatteryManager
表示电池充电状态的枚举。 表示电池充电状态的枚举。
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| -------- | -------- | -------- | | ------- | ---- | --------------- |
| NONE | 0 | 表示电池充电状态未知。 | | NONE | 0 | 表示电池充电状态未知。 |
| ENABLE | 1 | 表示电池充电状态为使能状态。 | | ENABLE | 1 | 表示电池充电状态为使能状态。 |
| DISABLE | 2 | 表示电池充电状态为停止状态。 | | DISABLE | 2 | 表示电池充电状态为停止状态。 |
| FULL | 3 | 表示电池充电状态为已充满状态。 | | FULL | 3 | 表示电池充电状态为已充满状态。 |
## BatteryHealthState ## BatteryHealthState
...@@ -67,11 +69,11 @@ SystemCapability.PowerManager.BatteryManager ...@@ -67,11 +69,11 @@ SystemCapability.PowerManager.BatteryManager
表示电池的健康状态的枚举。 表示电池的健康状态的枚举。
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| -------- | -------- | -------- | | ----------- | ---- | -------------- |
| UNKNOWN | 0 | 表示电池健康状态未知。 | | UNKNOWN | 0 | 表示电池健康状态未知。 |
| GOOD | 1 | 表示电池健康状态为正常。 | | GOOD | 1 | 表示电池健康状态为正常。 |
| OVERHEAT | 2 | 表示电池健康状态为过热。 | | OVERHEAT | 2 | 表示电池健康状态为过热。 |
| OVERVOLTAGE | 3 | 表示电池健康状态为过压。 | | OVERVOLTAGE | 3 | 表示电池健康状态为过压。 |
| COLD | 4 | 表示电池健康状态为低温。 | | COLD | 4 | 表示电池健康状态为低温。 |
| DEAD | 5 | 表示电池健康状态为僵死状态。 | | DEAD | 5 | 表示电池健康状态为僵死状态。 |
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 该模块提供屏幕亮度的设置接口。
## 导入模块 ## 导入模块
...@@ -21,9 +23,9 @@ setValue(value: number) ...@@ -21,9 +23,9 @@ setValue(value: number)
设置系统的屏幕亮度。 设置系统的屏幕亮度。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ----------- |
| value | number | 是 | 亮度的值(0~255) | | value | number | 是 | 亮度的值(0~255) |
- 示例: - 示例:
``` ```
......
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 该模块主要提供重启、关机、查询屏幕状态等接口。
## 导入模块 ## 导入模块
...@@ -12,7 +14,7 @@ import power from '@ohos.power'; ...@@ -12,7 +14,7 @@ import power from '@ohos.power';
## 系统能力 ## 系统能力
SystemCapability.PowerManager.PowerManager SystemCapability.PowerManager.PowerManager.Core
## power.shutdownDevice ## power.shutdownDevice
...@@ -25,9 +27,9 @@ shutdownDevice(reason: string): void ...@@ -25,9 +27,9 @@ shutdownDevice(reason: string): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ----- |
| reason | string | 是 | 关机原因。 | | reason | string | 是 | 关机原因。 |
**示例:** **示例:**
...@@ -43,13 +45,13 @@ rebootDevice(reason: string): void ...@@ -43,13 +45,13 @@ rebootDevice(reason: string): void
重启设备。 重启设备。
需要权限:ohos.permission.REBOOT(重启权限)、ohos.permission.REBOOT_RECOVERY(重启并进入recovery模式的权限) 需要权限:ohos.permission.REBOOT(重启权限)、ohos.permission.REBOOT_UPDATER(重启并进入updater模式的权限)
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ----- |
| reason | string | 是 | 重启原因。 | | reason | string | 是 | 重启原因。 |
**示例:** **示例:**
...@@ -67,9 +69,9 @@ isScreenOn(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -67,9 +69,9 @@ isScreenOn(callback: AsyncCallback&lt;boolean&gt;): void
**参数:** **参数:**
| 类型 | 类型 | 必填 | 说明 | | 类型 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 指定的callback回调方法,用于获取返回值。<br/>callback返回值:亮屏返回true,灭屏返回false。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 指定的callback回调方法,用于获取返回值。<br/>callback返回值:亮屏返回true,灭屏返回false。 |
**示例:** **示例:**
...@@ -91,8 +93,8 @@ isScreenOn(): Promise&lt;boolean&gt; ...@@ -91,8 +93,8 @@ isScreenOn(): Promise&lt;boolean&gt;
检测当前设备的亮灭屏状态。 检测当前设备的亮灭屏状态。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------- | --------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例,用于异步获取返回值,亮屏返回true,灭屏返回false。 | | Promise&lt;boolean&gt; | Promise实例,用于异步获取返回值,亮屏返回true,灭屏返回false。 |
**示例:** **示例:**
......
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 该模块主要提供Runninglock锁相关操作的接口,包括创建、查询、持锁、释放锁等操作。
## 导入模块 ## 导入模块
...@@ -13,17 +15,17 @@ import runninglock from '@ohos.runningLock'; ...@@ -13,17 +15,17 @@ import runninglock from '@ohos.runningLock';
## 系统能力 ## 系统能力
SystemCapability.PowerManager.PowerManager SystemCapability.PowerManager.PowerManager.Core
## RunningLockType ## RunningLockType
RunningLock锁的类型。 RunningLock锁的类型。
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| -------- | -------- | -------- | | ------------------------ | ---- | ------------------- |
| BACKGROUND | 1 | 阻止系统休眠的锁。 | | BACKGROUND | 1 | 阻止系统休眠的锁。 |
| PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 | | PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 |
## isRunningLockTypeSupported ## isRunningLockTypeSupported
...@@ -34,10 +36,10 @@ isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback&lt;boo ...@@ -34,10 +36,10 @@ isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback&lt;boo
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------- | ---- | ---------------------------------------- |
| type | RunningLockType | 是 | 需要查询的锁的类型。 | | type | RunningLockType | 是 | 需要查询的锁的类型。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 指定的callback回调方法,用于获取返回值。<br/>callback返回值:支持返回true,不支持返回false。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 指定的callback回调方法,用于获取返回值。<br/>callback返回值:支持返回true,不支持返回false。 |
**示例:** **示例:**
...@@ -60,14 +62,14 @@ isRunningLockTypeSupported(type: RunningLockType): Promise&lt;boolean&gt; ...@@ -60,14 +62,14 @@ isRunningLockTypeSupported(type: RunningLockType): Promise&lt;boolean&gt;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | --------------- | ---- | ---------- |
| type | RunningLockType | 是 | 需要查询的锁的类型。 | | type | RunningLockType | 是 | 需要查询的锁的类型。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------- | ---------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例,用于异步获取返回值,支持返回true,不支持返回false。 | | Promise&lt;boolean&gt; | Promise实例,用于异步获取返回值,支持返回true,不支持返回false。 |
**示例:** **示例:**
...@@ -93,11 +95,11 @@ createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback&l ...@@ -93,11 +95,11 @@ createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback&l
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| name | string | 是 | 锁的名字。 | | name | string | 是 | 锁的名字。 |
| type | RunningLockType | 是 | 要创建的锁的类型。 | | type | RunningLockType | 是 | 要创建的锁的类型。 |
| callback | AsyncCallback&lt;[RunningLock](#runninglock)&gt; | 是 | 指定的callback回调方法,用于获取返回的RunningLock锁对象。 | | callback | AsyncCallback&lt;[RunningLock](#runninglock)&gt; | 是 | 指定的callback回调方法,用于获取返回的RunningLock锁对象。 |
**示例:** **示例:**
...@@ -126,15 +128,15 @@ createRunningLock(name: string, type: RunningLockType): Promise&lt;RunningLock&g ...@@ -126,15 +128,15 @@ createRunningLock(name: string, type: RunningLockType): Promise&lt;RunningLock&g
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | --------------- | ---- | --------- |
| name | string | 是 | 锁的名字。 | | name | string | 是 | 锁的名字。 |
| type | RunningLockType | 是 | 要创建的锁的类型。 | | type | RunningLockType | 是 | 要创建的锁的类型。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------------- | ---------------------------------- |
| Promise&lt;[RunningLock](#runninglock)&gt; | Promise实例,用于异步获取返回的RunningLock锁对象。 | | Promise&lt;[RunningLock](#runninglock)&gt; | Promise实例,用于异步获取返回的RunningLock锁对象。 |
**示例:** **示例:**
...@@ -163,9 +165,9 @@ lock(timeout: number): void ...@@ -163,9 +165,9 @@ lock(timeout: number): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------ | ---- | -------------------- |
| timeout | number | 否 | 锁定和持有RunningLock的时长。 | | timeout | number | 否 | 锁定和持有RunningLock的时长。 |
**示例:** **示例:**
...@@ -208,8 +210,8 @@ isUsed(): boolean ...@@ -208,8 +210,8 @@ isUsed(): boolean
查询当前Runninglock是持有状态,还是释放状态。 查询当前Runninglock是持有状态,还是释放状态。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ------------------------------------- |
| boolean | 当前RunningLock是持有状态返回true,释放状态返回false。 | | boolean | 当前RunningLock是持有状态返回true,释放状态返回false。 |
**示例:** **示例:**
......
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 该模块主要提供设备热状态的监听接口。
## 导入模块 ## 导入模块
...@@ -15,15 +17,15 @@ import thermal from '@ohos.thermal'; ...@@ -15,15 +17,15 @@ import thermal from '@ohos.thermal';
热档位信息。 热档位信息。
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| -------- | -------- | -------- | | ---------- | ---- | ---------------------------------------- |
| COOL | 0 | 表明设备处于低温的状态,业务执行不受热控的限制。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager | | COOL | 0 | 表明设备处于低温的状态,业务执行不受热控的限制。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager |
| NORMAL | 1 | 表明设备处于正常工作状态,但温度不低,需要注意是否临近发热状态。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager | | NORMAL | 1 | 表明设备处于正常工作状态,但温度不低,需要注意是否临近发热状态。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager |
| WARM | 2 | 表明设备已经进入温热状态,部分无感知业务需要考虑停止或延迟执行。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager | | WARM | 2 | 表明设备已经进入温热状态,部分无感知业务需要考虑停止或延迟执行。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager |
| HOT | 3 | 表明设备已经明显发热,无感知业务应全面停止,其他业务应考虑降规格及负载。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager | | HOT | 3 | 表明设备已经明显发热,无感知业务应全面停止,其他业务应考虑降规格及负载。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager |
| OVERHEATED | 4 | 表明设备已经发热严重,无感知业务应全面停止,主要业务需降低规格及负载。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager | | OVERHEATED | 4 | 表明设备已经发热严重,无感知业务应全面停止,主要业务需降低规格及负载。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager |
| WARNING | 5 | 表明设备已经发热严重并且即将进入紧急状态,无感知业务应全面停止,主要业务应降低至最低规格。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager | | WARNING | 5 | 表明设备已经发热严重并且即将进入紧急状态,无感知业务应全面停止,主要业务应降低至最低规格。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager |
| EMERGENCY | 6 | 表明设备已经进入紧急状态,所有业务应当全面停止工作,可保留部分紧急求助功能。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager | | EMERGENCY | 6 | 表明设备已经进入紧急状态,所有业务应当全面停止工作,可保留部分紧急求助功能。<br/>**系统能力:** SystemCapability.PowerManager.ThermalManager |
## thermal.subscribeThermalLevel ## thermal.subscribeThermalLevel
...@@ -36,13 +38,14 @@ subscribeThermalLevel(callback: AsyncCallback&lt;ThermalLevel&gt;): void ...@@ -36,13 +38,14 @@ subscribeThermalLevel(callback: AsyncCallback&lt;ThermalLevel&gt;): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | --------------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback&lt;ThermalLevel&gt; | 是 | 指定的callback回调方法,用于获取返回值。<br/>callback返回值:热档位信息。 | | callback | AsyncCallback&lt;ThermalLevel&gt; | 是 | 指定的callback回调方法,用于获取返回值。<br/>callback返回值:热档位信息。 |
**示例:** **示例:**
``` ```
var lev = 0;
thermal.subscribeThermalLevel((lev) => { thermal.subscribeThermalLevel((lev) => {
console.info("Thermal level is: " + lev); console.info("Thermal level is: " + lev);
}) })
...@@ -58,9 +61,9 @@ unsubscribeThermalLevel(callback?: AsyncCallback<void>): void ...@@ -58,9 +61,9 @@ unsubscribeThermalLevel(callback?: AsyncCallback<void>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | --------------------- |
| callback | AsyncCallback&lt;void&gt; | 可选 | 指定的callback回调方法,无返回值。 | | callback | AsyncCallback&lt;void&gt; | 可选 | 指定的callback回调方法,无返回值。 |
**示例:** **示例:**
...@@ -80,8 +83,8 @@ getThermalLevel(): ThermalLevel ...@@ -80,8 +83,8 @@ getThermalLevel(): ThermalLevel
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------ | ------ |
| ThermalLevel | 热档位信息。 | | ThermalLevel | 热档位信息。 |
**示例:** **示例:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册