diff --git a/zh-cn/application-dev/reference/apis/js-apis-battery-info.md b/zh-cn/application-dev/reference/apis/js-apis-battery-info.md index 6c509570ae5161f40d308c34f6ac4d028071c741..ee13cd0a36bab93aae06edef41bb8e7f3180ead1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-battery-info.md +++ b/zh-cn/application-dev/reference/apis/js-apis-battery-info.md @@ -18,27 +18,21 @@ import batteryInfo from '@ohos.batteryInfo'; **系统能力**：SystemCapability.PowerManager.BatteryManager.Core -| 名称 | 类型 | 可读 | 可写 | 描述 | -| ----------------------------------------- | ---------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | -| batterySOC | number | 是 | 否 | 表示当前设备剩余电池电量百分比。 | -| chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 否 | 表示当前设备电池的充电状态。 | -| healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 否 | 表示当前设备电池的健康状态。 | -| pluggedType | [BatteryPluggedType](#batterypluggedtype) | 是 | 否 | 表示当前设备连接的充电器类型。 | -| voltage | number | 是 | 否 | 表示当前设备电池的电压，单位微伏。 | -| technology | string | 是 | 否 | 表示当前设备电池的技术型号。 | -| batteryTemperature | number | 是 | 否 | 表示当前设备电池的温度，单位0.1摄氏度。 | -| isBatteryPresent7+ | boolean | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 | -| batteryCapacityLevel9+ | [BatteryCapacityLevel](#batterycapacitylevel9) | 是 | 否 | 表示当前设备电池电量的等级。 | -| estimatedRemainingChargeTime9+ | number | 是 | 否 | 表示当前设备充满电的预估时间，单位毫秒。 | -| totalEnergy9+ | number | 是 | 否 | 表示当前设备电池的总容量，单位毫安时。此接口为系统接口，三方应用不支持调用。 | -| nowCurrent9+ | number | 是 | 否 | 表示当前设备电池的电流，单位毫安。此接口为系统接口，三方应用不支持调用。 | -| remainingEnergy9+ | number | 是 | 否 | 表示当前设备电池的剩余容量，单位毫安时。此接口为系统接口，三方应用不支持调用。 | - -- 示例： - ```js - import batteryInfo from '@ohos.batteryInfo'; - var batterySoc = batteryInfo.batterySOC; - ``` +| 名称 | 类型 | 可读 | 可写 | 描述 | +| ----------------------------------------- | ---------------------------------------------- | ---- | ---- | ---------------------------------------------------------- | +| batterySOC | number | 是 | 否 | 表示当前设备剩余电池电量百分比。 | +| chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 否 | 表示当前设备电池的充电状态。 | +| healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 否 | 表示当前设备电池的健康状态。 | +| pluggedType | [BatteryPluggedType](#batterypluggedtype) | 是 | 否 | 表示当前设备连接的充电器类型。 | +| voltage | number | 是 | 否 | 表示当前设备电池的电压，单位微伏。 | +| technology | string | 是 | 否 | 表示当前设备电池的技术型号。 | +| batteryTemperature | number | 是 | 否 | 表示当前设备电池的温度，单位0.1摄氏度。 | +| isBatteryPresent7+ | boolean | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 | +| batteryCapacityLevel9+ | [BatteryCapacityLevel](#batterycapacitylevel9) | 是 | 否 | 表示当前设备电池电量的等级。 | +| estimatedRemainingChargeTime9+ | number | 是 | 否 | 表示当前设备充满电的预估时间，单位毫秒。 | +| totalEnergy9+ | number | 是 | 否 | 表示当前设备电池的总容量，单位毫安时。此接口为系统接口。 | +| nowCurrent9+ | number | 是 | 否 | 表示当前设备电池的电流，单位毫安。此接口为系统接口。 | +| remainingEnergy9+ | number | 是 | 否 | 表示当前设备电池的剩余容量，单位毫安时。此接口为系统接口。 | ## BatteryPluggedType @@ -105,22 +99,22 @@ import batteryInfo from '@ohos.batteryInfo'; ## CommonEventBatteryChangedCode9+ -表示COMMON_EVENT_BATTERY_CHANGED通用事件的键代码。 +表示COMMON_EVENT_BATTERY_CHANGED通用事件附加信息的查询键。 **系统能力**：SystemCapability.PowerManager.BatteryManager.Core | 名称 | 默认值 | 描述 | | -------------------- | ------ | -------------------------------------------------- | -| EXTRA_SOC | 0 | 表示剩余电池电量百分比的键代码。 | -| EXTRA_VOLTAGE | 1 | 表示当前设备电池电压的键代码。 | -| EXTRA_TEMPERATURE | 2 | 表示当前设备电池温度的键代码。 | -| EXTRA_HEALTH_STATE | 3 | 表示当前设备电池健康状态的键代码。 | -| EXTRA_PLUGGED_TYPE | 4 | 表示当前设备连接的充电器类型的键代码。 | -| EXTRA_MAX_CURRENT | 5 | 表示当前设备电池最大电流的键代码。 | -| EXTRA_MAX_VOLTAGE | 6 | 表示当前设备电池最大电压的键代码。 | -| EXTRA_CHARGE_STATE | 7 | 表示当前设备电池充电状态的键代码。 | -| EXTRA_CHARGE_COUNTER | 8 | 表示当前设备电池充电次数的键代码。 | -| EXTRA_PRESENT | 9 | 表示当前设备是否支持电池或者电池是否在位的键代码。 | -| EXTRA_TECHNOLOGY | 10 | 表示当前设备电池技术型号的键代码。 | +| EXTRA_SOC | 0 | 表示剩余电池电量百分比的查询键。 | +| EXTRA_VOLTAGE | 1 | 表示当前设备电池电压的查询键。 | +| EXTRA_TEMPERATURE | 2 | 表示当前设备电池温度的查询键。 | +| EXTRA_HEALTH_STATE | 3 | 表示当前设备电池健康状态的查询键。 | +| EXTRA_PLUGGED_TYPE | 4 | 表示当前设备连接的充电器类型的查询键。 | +| EXTRA_MAX_CURRENT | 5 | 表示当前设备电池最大电流的查询键。 | +| EXTRA_MAX_VOLTAGE | 6 | 表示当前设备电池最大电压的查询键。 | +| EXTRA_CHARGE_STATE | 7 | 表示当前设备电池充电状态的查询键。 | +| EXTRA_CHARGE_COUNTER | 8 | 表示当前设备电池充电次数的查询键。 | +| EXTRA_PRESENT | 9 | 表示当前设备是否支持电池或者电池是否在位的查询键。 | +| EXTRA_TECHNOLOGY | 10 | 表示当前设备电池技术型号的查询键。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md b/zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md new file mode 100644 index 0000000000000000000000000000000000000000..b45211b32b00a41d683e7c9634c40ca07ee3c2ec --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md @@ -0,0 +1,298 @@ +# 耗电统计 + +该模块提供软硬件耗电统计信息的查询接口。 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> +> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> +> - 本模块接口为系统接口。 + +## 导入模块 + +```js +import batteryStats from '@ohos.batteryStatistics'; +``` + +## batteryStats.getBatteryStats + +getBatteryStats(): Promise> + +获取耗电信息列表。使用Promise异步回调。 + +**系统接口：** 此接口为系统接口。 + +**系统能力：** SystemCapability.PowerManager.BatteryStatistics + +**返回值：** + +| 类型 | 说明 | +| ----------------------------------------------------- | ------------------------------- | +| Promise> | Promise对象，返回耗电信息列表。 | + +**错误码：** + +以下错误码的详细介绍请参见[耗电统计错误码](../errorcodes/errorcode-batteryStatistics.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 4600101 | 连接服务失败。 | + +**示例：** + +```js +batteryStats.getBatteryStats() +.then(data => { + console.info('battery statistics info: ' + data); +}) +.catch(err => { + console.error('get battery statisitics failed, err: ' + err); +}); +``` + +## batteryStats.getBatteryStats + +getBatteryStats(callback: AsyncCallback>): void + +获取耗电信息列表。使用callback异步回调。 + +**系统接口：** 此接口为系统接口。 + +**系统能力：** SystemCapability.PowerManager.BatteryStatistics + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback> | 是 | 回调函数。当获取耗电信息列表成功，err为undefined，data为获取到的Array<[BatteryStatsInfo](#batterystatsinfo)>>；否则为错误对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[耗电统计错误码](../errorcodes/errorcode-batteryStatistics.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4600101 | 连接服务失败。 | + +**示例：** + +```js +batteryStats.getBatteryStats((err, data) => { + if (typeof err === 'undefined') { + console.info('battery statistics info: ' + data); + } else { + console.error('get battery statisitics failed, err: ' + err); + } +}); +``` + +## batteryStats.getAppPowerValue + +getAppPowerValue(uid: number): number + +获取应用的耗电量。 + +**系统接口：** 此接口为系统接口。 + +**系统能力：** SystemCapability.PowerManager.BatteryStatistics + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ----------- | +| uid | number | 是 | 应用的UID。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | --------------------------------- | +| number | UID对应应用的耗电量，单位毫安时。 | + +**错误码：** + +以下错误码的详细介绍请参见[耗电统计错误码](../errorcodes/errorcode-batteryStatistics.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4600101 | 连接服务失败。 | + +**示例：** + +```js +try { + var value = batteryStats.getAppPowerValue(10021); + console.info('battery statistics value of app is: ' + value); +} catch(err) { + console.error('get battery statisitics value of app failed, err: ' + err); +} +``` + +## batteryStats.getAppPowerPercent + +getAppPowerPercent(uid: number): number + +获取应用的耗电百分比。 + +**系统能力：** 此接口为系统接口。 + +**系统能力：** SystemCapability.PowerManager.BatteryStatistics + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ----------- | +| uid | number | 是 | 应用的UID。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ------------------------- | +| number | UID对应应用的耗电百分比。 | + +**错误码：** + +以下错误码的详细介绍请参见[耗电统计错误码](../errorcodes/errorcode-batteryStatistics.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4600101 | 连接服务失败。 | + +**示例：** + +```js +try { + var percent = batteryStats.getAppPowerPercent(10021); + console.info('battery statistics percent of app is: ' + percent); +} catch(err) { + console.error('get battery statisitics percent of app failed, err: ' + err); +} +``` + +## batteryStats.getHardwareUnitPowerValue + +getHardwareUnitPowerValue(type: [ConsumptionType](#consumptiontype)): number + +根据耗电类型获取硬件单元的耗电量。 + +**系统接口：** 此接口为系统接口。 + +**系统能力：** SystemCapability.PowerManager.BatteryStatistics + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | -------------- | +| type | [ConsumptionType](#consumptiontype) | 是 | 电量消耗类型。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ------------------------------------------ | +| number | 电量消耗类型对应硬件的耗电量，单位毫安时。 | + +**错误码：** + +以下错误码的详细介绍请参见[耗电统计错误码](../errorcodes/errorcode-batteryStatistics.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4600101 | 连接服务失败。 | + +**示例：** + +```js +try { + var value = batteryStats.getHardwareUnitPowerValue(ConsumptionType.CONSUMPTION_TYPE_SCREEN); + console.info('battery statistics percent of hardware is: ' + percent); +} catch(err) { + console.error('get battery statisitics percent of hardware failed, err: ' + err); +} +``` + +## batteryStats.getHardwareUnitPowerPercent + +getHardwareUnitPowerPercent(type: [ConsumptionType](#consumptiontype)): number + +根据耗电类型获取硬件单元的耗电百分比。 + +**系统接口：** 此接口为系统接口。 + +**系统能力：** SystemCapability.PowerManager.BatteryStatistics + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | -------------- | +| type | [ConsumptionType](#consumptiontype) | 是 | 电量消耗类型。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ---------------------------------- | +| number | 电量消耗类型对应硬件的耗电百分比。 | + +**错误码：** + +以下错误码的详细介绍请参见[耗电统计错误码](../errorcodes/errorcode-batteryStatistics.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4600101 | 连接服务失败。 | + +**示例：** + +```js +try { + var value = batteryStats.getHardwareUnitPowerPercent(ConsumptionType.CONSUMPTION_TYPE_SCREEN); + console.info('battery statistics percent of hardware is: ' + percent); +} catch(err) { + console.error('get battery statisitics percent of hardware failed, err: ' + err); +} +``` + +## BatteryStatsInfo + +设备的耗电信息。 + +**系统接口：** 此接口为系统接口。 + +**系统能力：** SystemCapability.PowerManager.BatteryStatistics + +### 属性 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----- | ----------------------------------- | ---- | ---- | ---------------------- | +| uid | number | 是 | 否 | 耗电信息相关的UID。 | +| type | [ConsumptionType](#consumptiontype) | 是 | 否 | 耗电信息相关的类型。 | +| power | number | 是 | 否 | 耗电的值，单位毫安时。 | + +## ConsumptionType + +表示电量消耗类型的枚举值。 + +**系统接口：** 此接口为系统接口。 + +**系统能力：** SystemCapability.PowerManager.BatteryStatistics + +| 名称 | 值 | 说明 | +| -------------------------- | ---- | ----------------------------- | +| CONSUMPTION_TYPE_INVALID | -17 | 表示电量消耗类型未知。 | +| CONSUMPTION_TYPE_APP | -16 | 表示应用消耗的电量类型。 | +| CONSUMPTION_TYPE_BLUETOOTH | -15 | 表示蓝牙消耗的电量类型。 | +| CONSUMPTION_TYPE_IDLE | -14 | 表示CPU空闲时消耗的电量类型。 | +| CONSUMPTION_TYPE_PHONE | -13 | 表示通话来电消耗的电量类型。 | +| CONSUMPTION_TYPE_RADIO | -12 | 表示无线通讯消耗的电量类型。 | +| CONSUMPTION_TYPE_SCREEN | -11 | 表示屏幕消耗的电量类型。 | +| CONSUMPTION_TYPE_USER | -10 | 表示用户消耗的电量类型。 | +| CONSUMPTION_TYPE_WIFI | -9 | 表示无线网消耗的电量类型。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-brightness.md b/zh-cn/application-dev/reference/apis/js-apis-brightness.md index e313d9fafc58bfd6e787c37aea890833f4965c7a..edff8297add3b2958deb3e06cb21f76b40a36275 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-brightness.md +++ b/zh-cn/application-dev/reference/apis/js-apis-brightness.md @@ -3,8 +3,10 @@ 该模块提供屏幕亮度的设置接口。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - +> +> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> +> - 本模块接口为系统接口。 ## 导入模块 @@ -18,18 +20,32 @@ setValue(value: number): void 设置系统的屏幕亮度。 -此接口为系统接口，三方应用不支持调用。 +**系统接口：** 此接口为系统接口。 **系统能力：** SystemCapability.PowerManager.DisplayPowerManager **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | ----------- | -| value | number | 是 | 亮度的值（0~255） | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ----------------------- | +| value | number | 是 | 亮度的值。范围：0~255。 | + +**错误码：** + +以下错误码的详细介绍请参见[屏幕亮度错误码](../errorcodes/errorcode-brightness.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4700101 | 连接服务失败。 | **示例：** ```js -brightness.setValue(128); +try { + brightness.setValue(128); +} catch(err) { + console.error('set brightness failed, err: ' + err); +} ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-power.md b/zh-cn/application-dev/reference/apis/js-apis-power.md index 4f0bbc49c9627e1280a8a78f7befc241c048cf00..801ba8ec451cfce9cbd45bfb0afc9ea89217db7e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-power.md +++ b/zh-cn/application-dev/reference/apis/js-apis-power.md @@ -5,21 +5,19 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - ## 导入模块 ```js import power from '@ohos.power'; ``` +## power.shutdown -## power.shutdownDevice - -shutdownDevice(reason: string): void +shutdown(reason: string): void 系统关机。 -此接口为系统接口，三方应用不支持调用。 +**系统接口：** 此接口为系统接口。 **需要权限：** ohos.permission.REBOOT @@ -31,18 +29,32 @@ shutdownDevice(reason: string): void | ------ | ------ | ---- | ----- | | reason | string | 是 | 关机原因。 | +**错误码：** + +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4900101 | 连接服务失败。 | + **示例：** ```js -power.shutdownDevice("shutdown_test"); -console.info('power_shutdown_device_test success') +try { + power.shutdown('shutdown_test'); +} catch(err) { + console.error('shutdown failed, err: ' + err); +} ``` - -## power.rebootDevice +## power.rebootDevice(deprecated) rebootDevice(reason: string): void +> 从API version 9开始不再维护，建议使用[power.reboot](#power.reboot9)替代。 + 重启设备。 **需要权限：** ohos.permission.REBOOT @@ -58,135 +70,196 @@ rebootDevice(reason: string): void **示例：** ```js -power.rebootDevice("reboot_test"); -console.info('power_reboot_device_test success') +power.rebootDevice('reboot_test'); ``` +## power.reboot9+ + +reboot(reason: string): void + +重启设备。 + +**系统接口：** 此接口为系统接口。 + +**需要权限：** ohos.permission.REBOOT + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------- | +| reason | string | 是 | 重启原因。 | + +**错误码：** -## power.isScreenOn +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4900101 | 连接服务失败。 | + +**示例：** + +```js +try { + power.reboot('reboot_test'); +} catch(err) { + console.error('reboot failed, err: ' + err); +} +``` + +## power.isScreenOn(deprecated) isScreenOn(callback: AsyncCallback<boolean>): void -检测当前设备的亮灭屏状态。 +> 从API version 9开始不再维护，建议使用[power.isActive](#power.isactive9)替代。 + +检测当前设备的亮灭屏状态。使用callback异步回调。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------- | ---- | ---------------------------------------- | -| callback | AsyncCallback<boolean> | 是 | 指定的callback回调方法，用于获取返回值。
callback返回值：亮屏返回true，灭屏返回false。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当检测成功，err为undefined，data为获取到的亮灭屏状态，返回true表示梁平，返回false表示灭屏；否则为错误对象。 | **示例：** ```js -power.isScreenOn((error, screenOn) => { - if (typeof error === "undefined") { - console.info('screenOn status is ' + screenOn); +power.isScreenOn((err, data) => { + if (typeof err === 'undefined') { + console.info('screen on status is ' + data); } else { - console.log('error: ' + error); + console.error('check screen status failed, err: ' + err); } }) ``` - -## power.isScreenOn +## power.isScreenOn(deprecated) isScreenOn(): Promise<boolean> -检测当前设备的亮灭屏状态。 +> 从API version 9开始不再维护，建议使用[power.isActive](#power.isactive9)替代。 + +检测当前设备的亮灭屏状态。使用Promise异步回调。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core **返回值：** -| 类型 | 说明 | -| ---------------------- | --------------------------------------- | -| Promise<boolean> | Promise实例，用于异步获取返回值，亮屏返回true，灭屏返回false。 | +| 类型 | 说明 | +| ---------------------- | -------------------------------------------------- | +| Promise<boolean> | Promise对象。返回true表示亮屏；返回false表示灭屏。 | **示例：** ```js power.isScreenOn() -.then(screenOn => { - console.info('screenOn status is ' + screenOn); +.then(data => { + console.info('screen on status is ' + data); }) -.catch(error => { - console.log('error: ' + error); +.catch(err => { + console.error('check screen status failed, err: ' + err); }) ``` -## power.wakeupDevice9+ +## power.isActive9+ -wakeupDevice(detail: string): void +isActive(): boolean -唤醒设备。 - -此接口为系统接口，三方应用不支持调用。 +检测当前设备是否处于活动状态。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core -**参数：** +**错误码：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------- | -| detail | string | 是 | 唤醒原因。 | +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4900101 | 连接服务失败。 | **示例：** ```js -power.wakeupDevice("application"); -console.info('power_wakeup_device_test success') +try { + var isActive = power.isActive(); +} catch(err) { + console.error('check active status failed, err: ' + err); +} ``` -## power.suspendDevice9+ +## power.wakeup9+ -suspendDevice(): void +wakeup(detail: string): void -休眠设备。 +唤醒设备。 -此接口为系统接口，三方应用不支持调用。 +**系统接口：** 此接口为系统接口。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------- | +| detail | string | 是 | 唤醒原因。 | + +**错误码：** + +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4900101 | 连接服务失败。 | + **示例：** ```js -power.suspendDevice(); -console.info('power_suspend_device_test success') +try { + power.wakeup('wakeup_test'); +} catch(err) { + console.error('wakeup failed, err: ' + err); +} ``` -## power.getPowerMode9+ +## power.suspend9+ -getPowerMode(callback: AsyncCallback<DevicePowerMode>): void +suspend(): void -获取当前设备的电源模式。 +休眠设备。 -**需要权限：** ohos.permission.POWER_OPTIMIZATION +**系统接口：** 此接口为系统接口。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core -**参数：** +**错误码：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------ | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback<DevicePowerMode> | 是 | 指定的callback回调方法，用于获取返回值。
callback返回值：[DevicePowerMode](#devicepowermode9)。 | +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 4900101 | 连接服务失败。 | **示例：** ```js -power.getPowerMode((error, mode) => { - if (typeof error === "undefined") { - console.info('power mode is ' + mode); - } else { - console.log('error: ' + error); - } -}) +try { + power.wakeup('wakeup_test'); +} catch(err) { + console.error('wakeup failed, err: ' + err); +} ``` - ## power.getPowerMode9+ -getPowerMode(): Promise<DevicePowerMode> +getPowerMode(): [DevicePowerMode](#devicepowermode9) 获取当前设备的电源模式。 @@ -196,29 +269,36 @@ getPowerMode(): Promise<DevicePowerMode> **返回值：** -| 类型 | 说明 | -| ------------------------------ | ------------------------------------------------------------ | -| Promise<DevicePowerMode> | Promise实例，用于异步获取返回值，[DevicePowerMode](#devicepowermode9)。 | +| 类型 | 说明 | +| ------------------------------------ | ---------- | +| [DevicePowerMode](#devicepowermode9) | 电源模式。 | + +**错误码：** + +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 4900101 | 连接服务失败。 | **示例：** ```js -power.getPowerMode() -.then(mode => { - console.info('power mode is ' + mode); -}) -.catch(error => { - console.log('error: ' + error); -}) +try { + var mode = power.getPowerMode(); +} catch(err) { + console.error('get power mode failed, err: ' + err); +} ``` ## power.setPowerMode9+ -setPowerMode(mode: DevicePowerMode, callback: AsyncCallback<void>): void +setPowerMode(mode: [DevicePowerMode](#devicepowermode9), callback: AsyncCallback<void>): void -设置当前设备的电源模式。 +设置当前设备的电源模式。使用callback异步回调。 -此接口为系统接口，三方应用不支持调用。 +**系统接口：** 此接口为系统接口。 **需要权限：** ohos.permission.POWER_OPTIMIZATION @@ -226,31 +306,44 @@ setPowerMode(mode: DevicePowerMode, callback: AsyncCallback<void>): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------ | ---- | ------------------------ | -| mode | [DevicePowerMode](#devicepowermode9) | 是 | 电源模式。 | -| callback | AsyncCallback<void> | 是 | 指定的callback回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------ | ---- | ------------------------------------------------------------ | +| mode | [DevicePowerMode](#devicepowermode9) | 是 | 电源模式。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置电源模式成功，err为undefined，否则为错误对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4900101 | 连接服务失败。 | **示例：** ```js -power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE, error => { - if (typeof error === "undefined") { - console.info('set power mode to MODE_PERFORMANCE'); - } else { - console.log('error: ' + error); - } -}) +try { + power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE, err => { + if (typeof err === 'undefined') { + console.info('set power mode to MODE_PERFORMANCE'); + } else { + console.error('set power mode failed, err: ' + err); + } + }); +} catch(err) { + console.error('set power mode failed, err: ' + err); +} ``` - ## power.setPowerMode9+ setPowerMode(mode: DevicePowerMode): Promise<void> -设置当前设备的电源模式。 +设置当前设备的电源模式。使用Promise异步回调。 -此接口为系统接口，三方应用不支持调用。 +**系统接口：** 此接口为系统接口。 **需要权限：** ohos.permission.POWER_OPTIMIZATION @@ -264,20 +357,34 @@ setPowerMode(mode: DevicePowerMode): Promise<void> **返回值：** -| 类型 | 说明 | -| ------------------- | ------------- | -| Promise<void> | Promise实例。 | +| 类型 | 说明 | +| ------------------- | -------------------------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4900101 | 链接服务失败。 | **示例：** ```js -power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE) -.then(() => { - console.info('set power mode to MODE_PERFORMANCE'); -}) -.catch(error => { - console.log('error: ' + error); -}) +try { + power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE) + .then(() => { + console.info('set power mode to MODE_PERFORMANCE'); + }) + .catch(err => { + console.error('set power mode failed, err: ' + err); + }); +} catch(err) { + console.error('set power mode failed, err: ' + err); +} ``` ## DevicePowerMode9+ @@ -286,7 +393,6 @@ power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE) **系统能力：** SystemCapability.PowerManager.PowerManager.Core - | 名称 | 默认值 | 描述 | | ----------------------- | ------ | ---------------------- | | MODE_NORMAL | 600 | 表示标准模式，默认值。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-runninglock.md b/zh-cn/application-dev/reference/apis/js-apis-runninglock.md index 1b7bfab5917b1be6943cc9e107b386426551161c..93a8ee637a71186b166d4d83553c23b7bd581e58 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-runninglock.md +++ b/zh-cn/application-dev/reference/apis/js-apis-runninglock.md @@ -1,33 +1,82 @@ -# Runninglock锁 +# RunningLock锁 -该模块主要提供Runninglock锁相关操作的接口，包括创建、查询、持锁、释放锁等操作。 +该模块主要提供RunningLock锁相关操作的接口，包括创建、查询、持锁、释放锁等操作。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - ## 导入模块 -``` +```js import runningLock from '@ohos.runningLock'; ``` +## runningLock.isRunningLockTypeSupported(deprecated) -## RunningLockType +isRunningLockTypeSupported(type: [RunningLockType](#runninglocktype), callback: AsyncCallback<boolean>): void -RunningLock锁的类型。 +> 从API version 9开始不再维护，建议使用[runningLock.isSupported](#runninglockissupported9)替代。 + +查询系统是否支持该类型的锁。使用callback异步回调。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | +| type | [RunningLockType](#runninglocktype) | 是 | 需要查询的锁的类型。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当查询成功，err为undefined，data为获取到的支持情况，返回true表示支持，返回false表示不支持；否则为错误对象。 | + +**示例：** + +```js +runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND, (err, data) => { + if (typeof err === 'undefined') { + console.info('BACKGROUND lock support status: ' + data); + } else { + console.log('check BACKGROUND lock support status failed, err: ' + err); + } +}); +``` + +## runingLock.isRunningLockTypeSupported(deprecated) -**系统能力：** 以下各项对应的系统能力均为SystemCapability.PowerManager.PowerManager.Core +isRunningLockTypeSupported(type: [RunningLockType](#runninglocktype)): Promise<boolean> -| 名称 | 默认值 | 描述 | -| ------------------------ | ---- | ------------------- | -| BACKGROUND | 1 | 阻止系统休眠的锁。 | -| PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 | +> 从API version 9开始不再维护，建议使用[runningLock.isSupported](#runninglockissupported9)替代。 +查询系统是否支持该类型的锁。使用Promise异步回调。 -## isRunningLockTypeSupported +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | -------------------- | +| type | [RunningLockType](#runninglocktype) | 是 | 需要查询的锁的类型。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------- | ---------------------------------------------------- | +| Promise<boolean> | Promise对象。返回true表示支持；返回false表示不支持。 | + +**示例：** -isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback<boolean>): void +```js +runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND) +.then(data => { + console.info('BACKGROUND lock support status: ' + data); +}) +.catch(err => { + console.log('check BACKGROUND lock support status failed, err: ' + err); +}); +``` + +## runingLock.isSupported9+ + +isSupported(type: [RunningLockType](#runninglocktype)): boolean; 查询系统是否支持该类型的锁。 @@ -35,60 +84,107 @@ isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback<boo **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------- | ---- | ---------------------------------------- | -| type | RunningLockType | 是 | 需要查询的锁的类型。 | -| callback | AsyncCallback<boolean> | 是 | 指定的callback回调方法，用于获取返回值。
callback返回值：支持返回true，不支持返回false。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | -------------------- | +| type | [RunningLockType](#runninglocktype) | 是 | 需要查询的锁的类型。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | --------------------------------------- | +| boolean | 返回true表示支持，返回false表示不支持。 | + +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 401 | 参数检查失败。 | +| 4900101 | 连接服务失败。 | **示例：** +```js +try { + var isSupported = runningLock.isSupported(runningLock.RunningLockType.BACKGROUND); +} catch(err) { + console.error('check supported failed, err: ' + err); +} ``` -runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND, (error, supported) => { - if (typeof error === "undefined") { - console.info('BACKGROUND support status is ' + supported); + +## runningLock.createRunningLock(deprecated) + +createRunningLock(name: string, type: [RunningLockType](#runninglocktype), callback: AsyncCallback<[RunningLock](#runninglock)>): void + +> 从API version 9开始不再维护，建议使用[runningLock.create](#runninglockcreate9)替代。 + +创建RunningLock锁。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**需要权限：** ohos.permission.RUNNING_LOCK + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ | +| name | string | 是 | 锁的名字。 | +| type | [RunningLockType](#runninglocktype) | 是 | 要创建的锁的类型。 | +| callback | AsyncCallback<[RunningLock](#runninglock)> | 是 | 回调函数。当创建锁成功，err为undefined，data为创建的RunningLock；否则为错误对象。 | + +**示例：** + +```js +runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err, lock) => { + if (typeof err === 'undefined') { + console.info('created running lock: ' + lock); } else { - console.log('error: ' + error); + console.error('create running lock failed, err: ' + err); } -}) +}); ``` +## runingLock.createRunningLock(deprecated) -## isRunningLockTypeSupported +createRunningLock(name: string, type: [RunningLockType](#runninglocktype)): Promise<[RunningLock](#runninglock)> -isRunningLockTypeSupported(type: RunningLockType): Promise<boolean> +> 从API version 9开始不再维护，建议使用[runningLock.create](#runninglockcreate9)替代。 -查询系统是否支持该类型的锁。 +创建RunningLock锁。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core +**需要权限：** ohos.permission.RUNNING_LOCK + **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | --------------- | ---- | ---------- | -| type | RunningLockType | 是 | 需要查询的锁的类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | ------------------ | +| name | string | 是 | 锁的名字。 | +| type | [RunningLockType](#runninglocktype) | 是 | 要创建的锁的类型。 | **返回值：** -| 类型 | 说明 | -| ---------------------- | ---------------------------------------- | -| Promise<boolean> | Promise实例，用于异步获取返回值，支持返回true，不支持返回false。 | +| 类型 | 说明 | +| ------------------------------------------ | ------------------------------------ | +| Promise<[RunningLock](#runninglock)> | Promise对象，返回RunningLock锁对象。 | **示例：** -``` -runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.PROXIMITY_SCREEN_CONTROL) -.then(supported => { - console.info('PROXIMITY_SCREEN_CONTROL support status is ' + supported); +```js +runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + console.info('created running lock: ' + lock); }) -.catch(error => { - console.log('error: ' + error); +.catch(err => { + console.log('create running lock failed, err: ' + err); }); ``` +## runingLock.create9+ -## createRunningLock - -createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback<RunningLock>): void +createRunningLock(name: string, type: [RunningLockType](#runninglocktype), callback: AsyncCallback<RunningLock>): void 创建RunningLock锁。 @@ -98,34 +194,39 @@ createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback&l **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | -------------------------------------- | -| name | string | 是 | 锁的名字。 | -| type | RunningLockType | 是 | 要创建的锁的类型。 | -| callback | AsyncCallback<[RunningLock](#runninglock)> | 是 | 指定的callback回调方法，用于获取返回的RunningLock锁对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ | +| name | string | 是 | 锁的名字。 | +| type | [RunningLockType](#runninglocktype) | 是 | 要创建的锁的类型。 | +| callback | AsyncCallback<[RunningLock](#runninglock)> | 是 | 回调函数。当创建锁成功，err为undefined，data为创建的RunningLock；否则为错误对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|----------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4900101 | 连接服务器失败。 | **示例：** -``` -runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND, (error, lockIns) => { - if (typeof error === "undefined") { - console.log('create runningLock test error: ' + error); +```js +runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err, lock) => { + if (typeof err === 'undefined') { + console.info('created running lock: ' + lock); } else { - var used = lockIns.isUsed(); - console.info('runninglock is used: ' + used); - lockIns.lock(500); - used = lockIns.isUsed(); - console.info('after lock runninglock is used ' + used); + console.error('create running lock failed, err: ' + err); } -}) +}); ``` +## runingLock.create9+ -## createRunningLock +createRunningLock(name: string, type: [RunningLockType](#runninglocktype)): Promise<RunningLock> -createRunningLock(name: string, type: RunningLockType): Promise<RunningLock> - -创建Runninglock锁。 +创建RunningLock锁。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core @@ -133,39 +234,49 @@ createRunningLock(name: string, type: RunningLockType): Promise<RunningLock&g **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | --------------- | ---- | --------- | -| name | string | 是 | 锁的名字。 | -| type | RunningLockType | 是 | 要创建的锁的类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | ------------------ | +| name | string | 是 | 锁的名字。 | +| type | [RunningLockType](#runninglocktype) | 是 | 要创建的锁的类型。 | **返回值：** | 类型 | 说明 | -| ---------------------------------------- | ---------------------------------- | -| Promise<[RunningLock](#runninglock)> | Promise实例，用于异步获取返回的RunningLock锁对象。 | +| ------------------------------------------ | ------------------------------------ | +| Promise<[RunningLock](#runninglock)> | Promise对象，返回RunningLock锁对象。 | + +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|----------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4900101 | 连接服务器失败。 | **示例：** -``` -runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND) -.then(runninglock => { - console.info('create runningLock success'); -}) -.catch(error => { - console.log('create runningLock test error: ' + error); +```js +runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + console.info('created running lock: ' + lock); }) +.catch(err => { + console.error('create running lock failed, error: ' + err); +}); ``` - ## RunningLock 阻止系统休眠的锁。 - -### lock +### lock(deprecated) lock(timeout: number): void +> 从API version 9开始不再维护，建议使用[RunningLock.hold](#hold9)替代。 + 锁定和持有RunningLock。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core @@ -180,23 +291,68 @@ lock(timeout: number): void **示例：** -``` -runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND) -.then(runningLock => { - runningLock.lock(100) - console.info('create runningLock success') +```js +runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + lock.lock(500); + console.info('create running lock and lock success'); }) -.catch(error => { - console.log('create runningLock test error: ' + error) +.catch(err => { + console.error('create running lock failed, err: ' + err); }); ``` +### hold9+ + +hold(timeout: number): void + +锁定和持有RunningLock。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**需要权限：** ohos.permission.RUNNING_LOCK + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ----------------------------------------- | +| timeout | number | 否 | 锁定和持有RunningLock的时长，单位：毫秒。 | -### unlock +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|----------| +| 201 | 权限校验失败。 | +| 401 | 参数检查失败。 | +| 4900101 | 连接服务器失败。 | + +**示例：** + +```js +runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + console.info('create running lock success'); + try { + lock.hold(500); + console.info('hold running lock success'); + } catch(err) { + console.error('hold running lock failed, err: ' + err); + } +}) +.catch(err => { + console.error('create running lock failed, err: ' + err); +}); +``` + +### unlock(deprecated) unlock(): void -释放Runninglock锁。 +> 从API version 9开始不再维护，建议使用[RunningLock.unhold](#unhold9)替代。 + +释放RunningLock锁。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core @@ -204,40 +360,129 @@ unlock(): void **示例：** -``` -runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND) -.then(runningLock => { - runningLock.unlock() - console.info('create and unLock runningLock success') +```js +runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + lock.unlock(); + console.info('create running lock and unlock success'); }) -.catch(error => { - console.log('create runningLock test error: ' + error) +.catch(err => { + console.error('create running lock failed, err: ' + err); }); ``` +### unhold9+ + +unhold(): void + +释放RunningLock锁。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**需要权限：** ohos.permission.RUNNING_LOCK -### isUsed +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|----------| +| 201 | 权限校验失败。 | +| 4900101 | 连接服务器失败。 | + +**示例：** + +```js +runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + console.info('create running lock success'); + try { + lock.unhold(); + console.info('unhold running lock success'); + } catch(err) { + console.error('unhold running lock failed, err: ' + err); + } +}) +.catch(err => { + console.error('create running lock failed, err: ' + err); +}); +``` + +### isUsed(deprecated) isUsed(): boolean -查询当前Runninglock是持有状态还是释放状态。 +> 从API version 9开始不再维护，建议使用[RunningLock.isHolding](#isholding9)替代。 + +查询当前RunningLock是持有状态还是释放状态。 **系统能力：** SystemCapability.PowerManager.PowerManager.Core **返回值：** -| 类型 | 说明 | -| ------- | ------------------------------------- | -| boolean | 当前RunningLock是持有状态返回true，释放状态返回false。 | +| 类型 | 说明 | +| ------- | ------------------------------------------------------------ | +| boolean | 返回true表示当前RunningLock是持有状态，返回false表示当前RunningLock是释放状态。 | **示例：** +```js +runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + var isUsed = lock.isUsed(); + console.info('check running lock used status: ' + isUsed); +}) +.catch(err => { + console.error('check running lock used status failed, err: ' + err); +}); ``` -runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.BACKGROUND) -.then(runningLock => { - var used = runningLock.isUsed() - console.info('runningLock used status: ' + used) + +### isHolding9+ + +isHolding(): boolean + +查询当前RunningLock是持有状态还是释放状态。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +**返回值：** + +| 类型 | 说明 | +| ------- | ------------------------------------------------------------ | +| boolean | 返回true表示当前RunningLock是持有状态，返回false表示当前RunningLock是释放状态。 | + +**错误码：** + +以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4900101 | 连接服务失败。 | + +**示例：** + +```js +runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND) +.then(lock => { + console.info('create running lock success'); + try { + var isHolding = lock.isHolding(); + console.info('check running lock holding status: ' + isHolding); + } catch(err) { + console.error('check running lock holding status failed, err: ' + err); + } }) -.catch(error => { - console.log('runningLock isUsed test error: ' + error) +.catch(err => { + console.error('create running lock failed, err: ' + err); }); ``` + +## RunningLockType + +RunningLock锁的类型。 + +**系统能力：** SystemCapability.PowerManager.PowerManager.Core + +| 名称 | 默认值 | 描述 | +| ------------------------ | ------ | -------------------------------------- | +| BACKGROUND | 1 | 阻止系统休眠的锁。 | +| PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-battery.md b/zh-cn/application-dev/reference/apis/js-apis-system-battery.md index 2c4b2dedd6ad05b58909ef2018d0c7abe46743c4..37274086d19dba1671a434ff55c7488a98de8c34 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-battery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-battery.md @@ -1,9 +1,10 @@ # 电量信息 -> **说明：** -> - 从API Version 6开始，该接口不再维护，推荐使用新接口[`@ohos.batteryInfo`](js-apis-battery-info.md)。 -> -> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +该模块提供充电状态及剩余电量的查询功能。 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> - 从API Version 6开始不再维护，建议使用[`@ohos.batteryInfo`](js-apis-battery-info.md)替代。 ## 导入模块 @@ -16,7 +17,7 @@ import battery from '@system.battery'; ## battery.getStatus -getStatus(Object): void +getStatus(options?: [GetStatusOptions](#getstatusoptions)): void; 获取设备当前的充电状态及剩余电量。 @@ -26,29 +27,35 @@ getStatus(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| success | (data: [BatteryResponse](#batteryresponse)) => void | 否 | 接口调用成功的回调函数。| -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。| -| complete | () => void | 否 | 接口调用结束的回调函数。 | +| options | [GetStatusOptions](#getstatusoptions) | 否 | 包含接口调用结果的对象。 | **示例：** ```js -export default { - getStatus() { - battery.getStatus({ - success: function(data) { - console.log('success get battery level:' + data.level); - }, - fail: function(data, code) { - console.log('fail to get battery level code:' + code + ', data: ' + data); - }, - }); - }, -} +battery.getStatus({ + success: function(data) { + console.log('success get battery level:' + data.level); + }, + fail: function(data, code) { + console.error('fail to get battery level code:' + code + ', data: ' + data); + } +}); ``` +## GetStatusOptions + +包含接口调用结果的对象。 + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ | +| success | (data: [BatteryResponse](#batteryresponse)) => void | 否 | 接口调用成功的回调函数，data为[BatteryResponse](#batteryresponse)类型的返回值。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | + ## BatteryResponse +包含充电状态及剩余电量的对象。 + | 参数名 | 类型 | 说明 | | -------- | -------- | -------- | | charging | boolean | 当前电池是否在充电中。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md b/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md index cf8e51aa4d1b60ca58443507a460b53ae55387bc..edc51f7dd32cbba947c38e8f1e8e3e1d1e44215f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-brightness.md @@ -1,9 +1,11 @@ # 屏幕亮度 -> **说明：** -> - 从API Version 7 开始，该接口不再维护，推荐使用新接口[`@ohos.brightness`](js-apis-brightness.md)。 -> +该模块提供屏幕亮度和模式的查询、调节接口。 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> - 从API Version 7 开始不再维护，建议使用[`@ohos.brightness`](js-apis-brightness.md)替代。 ## 导入模块 @@ -16,7 +18,7 @@ import brightness from '@system.brightness'; ## brightness.getValue -getValue(Object): void +getValue(options?: [GetBrightnessOptions](#getbrightnessoptions)): void 获得设备当前的屏幕亮度值。 @@ -26,38 +28,25 @@ getValue(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| success | (data: [BrightnessResponse](#brightnessresponse)) => void | 否 | 接口调用成功的回调函数。 | -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | -| complete | () => void | 否 | 接口调用结束的回调函数。 | - -success返回值： - -| 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| value | number | 屏幕亮度，取值为1-255之间的整数。 | - +| options | [GetBrightnessOptions](#getbrightnessoptions) | 否 | 获取屏幕亮度的参数对象。 | **示例：** ```js - export default { - getValue() { - brightness.getValue({ - success: function(data){ - console.log('success get brightness value:' + data.value); - }, - fail: function(data, code) { - console.log('get brightness fail, code: ' + code + ', data: ' + data); - }, - }); - }, - } + brightness.getValue({ + success: function(data) { + console.log('success get brightness value:' + data.value); + }, + fail: function(data, code) { + console.error('get brightness fail, code: ' + code + ', data: ' + data); + } + }); ``` ## brightness.setValue -setValue(Object): void +etValue(options?: [SetBrightnessOptions](#setbrightnessoptions)): void 设置设备当前的屏幕亮度值。 @@ -67,33 +56,26 @@ setValue(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | number | 是 | 屏幕亮度，值为1-255之间的整数。
- 如果值小于等于0，系统按1处理。
- 如果值大于255，系统按255处理。
- 如果值为小数，系统将处理为整数。例如设置为8.1，系统按8处理。 | -| success | () => void | 否 | 接口调用成功的回调函数。 | -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | -| complete | () => void | 否 | 接口调用结束的回调函数。 | +| options | [SetBrightnessOptions](#setbrightnessoptions) | 否 | 设置屏幕亮度的参数对象。 | **示例：** ```js - export default { - setValue() { - brightness.setValue({ - value: 100, - success: function(){ - console.log('handling set brightness success.'); - }, - fail: function(data, code){ - console.log('handling set brightness value fail, code:' + code + ', data: ' + data); - }, - }); - }, - } + brightness.setValue({ + value: 100, + success: function() { + console.log('handling set brightness success.'); + }, + fail: function(data, code) { + console.error('handling set brightness value fail, code:' + code + ', data: ' + data); + } + }); ``` ## brightness.getMode -getMode(Object): void +getMode(options?: [GetBrightnessModeOptions](#getbrightnessmodeoptions): void 获得当前屏幕亮度模式。 @@ -103,37 +85,25 @@ getMode(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| success | (data: [BrightnessModeResponse](#brightnessmoderesponse)) => void | 否 | 接口调用成功的回调函数。 | -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | -| complete | () => void | 否 | 接口调用结束的回调函数。 | - -success返回值： - -| 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| mode | number | 值为0或1：
- 0为手动调节屏幕亮度模式
- 1为自动调节屏幕亮度模式 | +| options | [GetBrightnessModeOptions](#getbrightnessmodeoptions) | 否 | 获取屏幕亮度模式的参数对象。 | **示例：** ```js - export default { - getMode() { - brightness.getMode({ - success: function(data){ - console.log('success get mode:' + data.mode); - }, - fail: function(data, code){ - console.log('handling get mode fail, code:' + code + ', data: ' + data); - }, - }); - }, - } + brightness.getMode({ + success: function(data) { + console.log('success get mode:' + data.mode); + }, + fail: function(data, code){ + console.error('handling get mode fail, code:' + code + ', data: ' + data); + } + }); ``` ## brightness.setMode -setMode(Object): void +setMode(options?: [SetBrightnessModeOptions](#setbrightnessmodeoptions)): void 设置设备当前的屏幕亮度模式。 @@ -142,74 +112,118 @@ setMode(Object): void **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| mode | number | 是 | 值为0或1
- 0为手动调节屏幕亮度。
- 1为自动调节屏幕亮度。 | -| success | () => void | 否 | 接口调用成功的回调函数。 | -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | -| complete | () => void | 否 | 接口调用结束的回调函数。 | +| options | [SetBrightnessModeOptions](#setbrightnessmodeoptions) | 否 | 设置屏幕亮度模式的参数对象。 | **示例：** ```js - export default { - setMode() { - brightness.setMode({ - mode: 1, - success: function(){ - console.log('handling set mode success.'); - }, - fail: function(data, code){ - console.log('handling set mode fail, code:' + code + ', data: ' + data); - }, - }); - }, - } + brightness.setMode({ + mode: 1, + success: function() { + console.log('handling set mode success.'); + }, + fail: function(data, code) { + console.error('handling set mode fail, code:' + code + ', data: ' + data); + } + }); ``` ## brightness.setKeepScreenOn -setKeepScreenOn(Object): void +setKeepScreenOn(options?: [SetKeepScreenOnOptions](#setkeepscreenonoptions)): void + +>从API version 7开始不再维护，建议使用[window.setKeepScreenOn](js-apis-window.md#setkeepscreenon)替代。 设置屏幕是否保持常亮状态，开启常亮模式推荐在onShow()阶段调用。 **系统能力：** SystemCapability.PowerManager.DisplayPowerManager **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| keepScreenOn | boolean | 是 | 是否保持屏幕常亮。 | -| success | () => void | 否 | 接口调用成功的回调函数。 | -| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | -| complete | () => void | 否 | 接口调用结束的回调函数。 | +| options | [SetKeepScreenOnOptions](#setkeepscreenonoptions) | 否 | 设置屏幕常亮的参数对象。 | **示例：** ```js - export default { - setKeepScreenOn() { - brightness.setKeepScreenOn({ - keepScreenOn: true, - success: function () { - console.log('handling set keep screen on success.') - }, - fail: function (data, code) { - console.log('handling set keep screen on fail, code:' + code + ', data: ' + data); - }, - }); - }, - } + brightness.setKeepScreenOn({ + keepScreenOn: true, + success: function () { + console.log('handling set keep screen on success.'); + }, + fail: function (data, code) { + console.error('handling set keep screen on fail, code:' + code + ', data: ' + data); + } + }); ``` -## +## GetBrightnessOptions + +获取屏幕亮度的参数对象。 + +| 名称 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| success | (data: [BrightnessResponse](#brightnessresponse)) => void | 否 | 接口调用成功的回调函数。data为[BrightnessResponse](#brightnessresponse)类型的返回值。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | + +## SetBrightnessOptions + +设置屏幕亮度的参数对象。 + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------ | ---- | ------------------------------------------------------------ | +| value | number | 是 | 屏幕亮度，值为1-255之间的整数。
- 如果值小于等于0，系统按1处理。
- 如果值大于255，系统按255处理。
- 如果值为小数，系统将处理为整数。例如设置为8.1，系统按8处理。 | +| success | () => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | ## BrightnessResponse +包含屏幕亮度的对象。 + | 名称 | 类型 | 说明 | | -------- | -------- | -------- | -| value | number | 屏幕亮度，取值为1-255之间的整数。 | +| value | number | 屏幕亮度，范围：1到255。 | + +## GetBrightnessModeOptions + +获取屏幕亮度模式的参数对象。 + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| success | (data: [BrightnessModeResponse](#brightnessmoderesponse)) => void | 否 | 接口调用成功的回调函数。data为[BrightnessModeResponse](#brightnessmoderesponse)类型的返回值。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | + +## SetBrightnessModeOptions + +设置屏幕亮度模式的参数对象。 + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------ | ---- | ------------------------------------------------------ | +| mode | number | 是 | 0表示手动调节屏幕亮度模式，1表示自动调节屏幕亮度模式。 | +| success | () => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | ## BrightnessModeResponse +包含屏幕亮度模式的对象。 + | 名称 | 类型 | 说明 | | -------- | -------- | -------- | -| mode | number | 值为0或1。
-0为手动调节屏幕亮度模式。
-1为手动调节屏幕亮度模式。 | +| mode | number | 0表示手动调节屏幕亮度模式，1表示自动调节屏幕亮度模式。 | + +## SetKeepScreenOnOptions + +设置屏幕常亮的参数对象。 + +| 名称 | 类型 | 必填 | 说明 | +| ------------ | ------------------------------------ | ---- | ------------------------------------------------------ | +| keepScreenOn | boolean | 是 | true表示保持屏幕常亮，false表示取消屏幕常亮。 | +| success | () => void | 否 | 接口调用成功的回调函数。 | +| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 | +| complete | () => void | 否 | 接口调用结束的回调函数。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-thermal.md b/zh-cn/application-dev/reference/apis/js-apis-thermal.md index 4c19beee330fb0ca0b0d4653e35fd4514b925131..873f474937b8609422103f21d11c9fa1fc7de0ac 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-thermal.md +++ b/zh-cn/application-dev/reference/apis/js-apis-thermal.md @@ -5,34 +5,39 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - ## 导入模块 ```js import thermal from '@ohos.thermal'; ``` +## thermal.subscribeThermalLevel(deprecated) -## ThermalLevel +subscribeThermalLevel(callback: AsyncCallback<ThermalLevel>): void -热档位信息。 +> 从API version 9开始不再维护，建议使用[thermal.registerThermalLevelCallback](#thermalregisterthermallevelcallback9)替代。 -**系统能力：** 以下各项对应的系统能力均为SystemCapability.PowerManager.ThermalManager +订阅热档位变化时的回调提醒。 -| 名称 | 默认值 | 描述 | -| ---------- | ---- | ---------------------------------------- | -| COOL | 0 | 表明设备处于低温的状态，业务执行不受热控的限制。 | -| NORMAL | 1 | 表明设备处于正常工作状态，但温度不低，需要注意是否临近发热状态 | -| WARM | 2 | 表明设备已经进入温热状态，部分无感知业务需要考虑停止或延迟执行。 | -| HOT | 3 | 表明设备已经明显发热，无感知业务应全面停止，其他业务应考虑降规格及负载。 | -| OVERHEATED | 4 | 表明设备已经发热严重，无感知业务应全面停止，主要业务需降低规格及负载。 | -| WARNING | 5 | 表明设备已经发热严重并且即将进入紧急状态，无感知业务应全面停止，主要业务应降低至最低规格。 | -| EMERGENCY | 6 | 表明设备已经进入紧急状态，所有业务应当全面停止工作，可保留部分紧急求助功能。 | +**系统能力：** SystemCapability.PowerManager.ThermalManager +**参数：** -## thermal.subscribeThermalLevel +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback<ThermalLevel> | 是 | 回调函数。AsyncCallback只返回一个参数，为热档位信息，此时可能会产生告警，可通过`// @ts-ignore`进行抑制。 | -subscribeThermalLevel(callback: AsyncCallback<ThermalLevel>): void +**示例：** + +```js +thermal.subscribeThermalLevel((level) => { + console.info('thermal level is: ' + level); +}); +``` + +## thermal.registerThermalLevelCallback9+ + +registerThermalLevelCallback(callback: Callback<ThermalLevel>): void 订阅热档位变化时的回调提醒。 @@ -40,45 +45,98 @@ subscribeThermalLevel(callback: AsyncCallback<ThermalLevel>): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------- | ---- | ---------------------------------------- | -| callback | AsyncCallback<ThermalLevel> | 是 | 指定的callback回调方法，用于获取返回值。
AsyncCallback只返回一个参数，为热档位信息，此时可能会产生告警，可通过`// @ts-ignore`进行抑制。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | ------------------------------ | +| callback | Callback<ThermalLevel> | 是 | 回调函数，返回变化后的热档位。 | + +**错误码：** + +以下错误码的详细介绍请参见[耗电统计错误码](../errorcodes/errorcode-thermal.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 401 | 参数检查失败。 | +| 4800101 | 连接服务失败。 | **示例：** ```js -var lev = 0; -thermal.subscribeThermalLevel((lev) => { - console.info("Thermal level is: " + lev); -}) +try { + thermal.registerThermalLevelCallback(level => { + console.info('thermal level is: ' + level); + }); + console.info('register thermal level callback success.'); +} catch(err) { + console.error('register thermal level callback failed, err: ' + err); +} ``` -## thermal.unsubscribeThermalLevel +## thermal.unsubscribeThermalLevel(deprecated) unsubscribeThermalLevel(callback?: AsyncCallback\): void +> 从API version 9开始不再维护，建议使用[thermal.unregisterThermalLevelCallback](#thermalunregisterthermallevelcallback9)替代。 + 取消订阅热档位变化时的回调提醒。 **系统能力：** SystemCapability.PowerManager.ThermalManager **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | --------------------- | -| callback | AsyncCallback<void> | 可选 | 指定的callback回调方法，无返回值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------------------------------------------- | +| callback | AsyncCallback<void> | 否 | 回调函数，无返回值。不填该参数则取消所有回调。 | **示例：** ```js thermal.unsubscribeThermalLevel(() => { - console.info("Unsubscribe completed."); + console.info('unsubscribe thermal level success.'); }); ``` -## thermal.getThermalLevel +## thermal.unregisterThermalLevelCallback9+ + +unregisterThermalLevelCallback(callback?: Callback\): void + +取消订阅热档位变化时的回调提醒。 + +**系统能力：** SystemCapability.PowerManager.ThermalManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ---------------------------------------------- | +| callback | Callback<void> | 可选 | 回调函数，无返回值。不填该参数则取消所有回调。 | + +**错误码：** + +以下错误码的详细介绍请参见[热管理错误码](../errorcodes/errorcode-thermal.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 401 | 参数检查失败。 | +| 4800101 | 连接服务失败。 | + +**示例：** + +```js +try { + thermal.unregisterThermalLevelCallback(() => { + console.info('unsubscribe thermal level success.'); + }); + console.info('unregister thermal level callback success.'); +} catch(err) { + console.error('unregister thermal level callback failed, err: ' + err); +} +``` + +## thermal.getThermalLevel(deprecated) getThermalLevel(): ThermalLevel +> 从API version 9开始不再维护，建议使用[thermal.getLevel](#thermalgetlevel9)替代。 + 获取当前热档位信息。 **系统能力：** SystemCapability.PowerManager.ThermalManager @@ -92,6 +150,55 @@ getThermalLevel(): ThermalLevel **示例：** ```js -var lev = thermal.getThermalLevel(); -console.info("Thermal level is: " + lev); +var level = thermal.getThermalLevel(); +console.info('thermal level is: ' + level); ``` + +## thermal.getLevel9+ + +getLevel(): ThermalLevel + +获取当前热档位信息。 + +**系统能力：** SystemCapability.PowerManager.ThermalManager + +**返回值：** + +| 类型 | 说明 | +| ------------ | ------------ | +| ThermalLevel | 热档位信息。 | + +**错误码：** + +以下错误码的详细介绍请参见[热管理错误码](../errorcodes/errorcode-thermal.md)。 + +| 错误码ID | 错误信息 | +|---------|---------| +| 4800101 | 连接服务失败。 | + +**示例：** + +```js +try { + var level = thermal.getLevel(); + console.info('thermal level is: ' + level); +} catch(err) { + console.error('get thermal level failed, err: ' + err); +} +``` + +## ThermalLevel + +热档位信息。 + +**系统能力：** SystemCapability.PowerManager.ThermalManager + +| 名称 | 默认值 | 描述 | +| ---------- | ------ | ------------------------------------------------------------ | +| COOL | 0 | 表明设备处于低温的状态，业务执行不受热控的限制。 | +| NORMAL | 1 | 表明设备处于正常工作状态，但温度不低，需要注意是否临近发热状态 | +| WARM | 2 | 表明设备已经进入温热状态，部分无感知业务需要考虑停止或延迟执行。 | +| HOT | 3 | 表明设备已经明显发热，无感知业务应全面停止，其他业务应考虑降规格及负载。 | +| OVERHEATED | 4 | 表明设备已经发热严重，无感知业务应全面停止，主要业务需降低规格及负载。 | +| WARNING | 5 | 表明设备已经发热严重并且即将进入紧急状态，无感知业务应全面停止，主要业务应降低至最低规格。 | +| EMERGENCY | 6 | 表明设备已经进入紧急状态，所有业务应当全面停止工作，可保留部分紧急求助功能。 |