Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
You need to sign in or sign up before continuing.
提交 7e3f846f 编写于 作者: A aqxyjay
浏览文件
操作

update references and support errorcode 

Signed-off-by: Naqxyjay <zhangchunxin@huawei.com>
上级 13617c89
展开全部 隐藏空白更改
内联 并排
Showing with 1186 addition and 399 deletion
zh-cn/application-dev/reference/apis/js-apis-battery-info.md
浏览文件 @ 7e3f846f
...@@ -18,27 +18,21 @@ import batteryInfo from '@ohos.batteryInfo'; ...@@ -18,27 +18,21 @@ import batteryInfo from '@ohos.batteryInfo';
**系统能力**：SystemCapability.PowerManager.BatteryManager.Core **系统能力**：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 | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 |
| batteryCapacityLevel<sup>9+</sup> | [BatteryCapacityLevel](#batterycapacitylevel9) | 是 | 否 | 表示当前设备电池电量的等级。 | | batteryCapacityLevel<sup>9+</sup> | [BatteryCapacityLevel](#batterycapacitylevel9) | 是 | 否 | 表示当前设备电池电量的等级。 |
| estimatedRemainingChargeTime<sup>9+</sup> | number | 是 | 否 | 表示当前设备充满电的预估时间，单位毫秒。 | | estimatedRemainingChargeTime<sup>9+</sup> | number | 是 | 否 | 表示当前设备充满电的预估时间，单位毫秒。 |
| totalEnergy<sup>9+</sup> | number | 是 | 否 | 表示当前设备电池的总容量，单位毫安时。此接口为系统接口，三方应用不支持调用。 | | totalEnergy<sup>9+</sup> | number | 是 | 否 | 表示当前设备电池的总容量，单位毫安时。此接口为系统接口。 |
| nowCurrent<sup>9+</sup> | number | 是 | 否 | 表示当前设备电池的电流，单位毫安。此接口为系统接口，三方应用不支持调用。 | | nowCurrent<sup>9+</sup> | number | 是 | 否 | 表示当前设备电池的电流，单位毫安。此接口为系统接口。 |
| remainingEnergy<sup>9+</sup> | number | 是 | 否 | 表示当前设备电池的剩余容量，单位毫安时。此接口为系统接口，三方应用不支持调用。 | | remainingEnergy<sup>9+</sup> | number | 是 | 否 | 表示当前设备电池的剩余容量，单位毫安时。此接口为系统接口。 |
- 示例：
```js
import batteryInfo from '@ohos.batteryInfo';
var batterySoc = batteryInfo.batterySOC;
```
## BatteryPluggedType ## BatteryPluggedType
...@@ -105,22 +99,22 @@ import batteryInfo from '@ohos.batteryInfo'; ...@@ -105,22 +99,22 @@ import batteryInfo from '@ohos.batteryInfo';
## CommonEventBatteryChangedCode<sup>9+</sup> ## CommonEventBatteryChangedCode<sup>9+</sup>
表示COMMON_EVENT_BATTERY_CHANGED通用事件的键代码。 表示COMMON_EVENT_BATTERY_CHANGED通用事件附加信息的查询键。
**系统能力**：SystemCapability.PowerManager.BatteryManager.Core **系统能力**：SystemCapability.PowerManager.BatteryManager.Core
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| -------------------- | ------ | -------------------------------------------------- | | -------------------- | ------ | -------------------------------------------------- |
| EXTRA_SOC | 0 | 表示剩余电池电量百分比的键代码。 | | EXTRA_SOC | 0 | 表示剩余电池电量百分比的查询键。 |
| EXTRA_VOLTAGE | 1 | 表示当前设备电池电压的键代码。 | | EXTRA_VOLTAGE | 1 | 表示当前设备电池电压的查询键。 |
| EXTRA_TEMPERATURE | 2 | 表示当前设备电池温度的键代码。 | | EXTRA_TEMPERATURE | 2 | 表示当前设备电池温度的查询键。 |
| EXTRA_HEALTH_STATE | 3 | 表示当前设备电池健康状态的键代码。 | | EXTRA_HEALTH_STATE | 3 | 表示当前设备电池健康状态的查询键。 |
| EXTRA_PLUGGED_TYPE | 4 | 表示当前设备连接的充电器类型的键代码。 | | EXTRA_PLUGGED_TYPE | 4 | 表示当前设备连接的充电器类型的查询键。 |
| EXTRA_MAX_CURRENT | 5 | 表示当前设备电池最大电流的键代码。 | | EXTRA_MAX_CURRENT | 5 | 表示当前设备电池最大电流的查询键。 |
| EXTRA_MAX_VOLTAGE | 6 | 表示当前设备电池最大电压的键代码。 | | EXTRA_MAX_VOLTAGE | 6 | 表示当前设备电池最大电压的查询键。 |
| EXTRA_CHARGE_STATE | 7 | 表示当前设备电池充电状态的键代码。 | | EXTRA_CHARGE_STATE | 7 | 表示当前设备电池充电状态的查询键。 |
| EXTRA_CHARGE_COUNTER | 8 | 表示当前设备电池充电次数的键代码。 | | EXTRA_CHARGE_COUNTER | 8 | 表示当前设备电池充电次数的查询键。 |
| EXTRA_PRESENT | 9 | 表示当前设备是否支持电池或者电池是否在位的键代码。 | | EXTRA_PRESENT | 9 | 表示当前设备是否支持电池或者电池是否在位的查询键。 |
| EXTRA_TECHNOLOGY | 10 | 表示当前设备电池技术型号的键代码。 | | EXTRA_TECHNOLOGY | 10 | 表示当前设备电池技术型号的查询键。 |
zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md 0 → 100644
浏览文件 @ 7e3f846f
# 耗电统计
该模块提供软硬件耗电统计信息的查询接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> - 本模块接口为系统接口。
## 导入模块
```js
import batteryStats from '@ohos.batteryStatistics';
```
## batteryStats.getBatteryStats
getBatteryStats(): Promise<Array<[BatteryStatsInfo](#batterystatsinfo)>>
获取耗电信息列表。使用Promise异步回调。
**系统接口：** 此接口为系统接口。
**系统能力：** SystemCapability.PowerManager.BatteryStatistics
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------------- | ------------------------------- |
| Promise<Array<[BatteryStatsInfo](#batterystatsinfo)>> | 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<Array<[BatteryStatsInfo](#batterystatsinfo)>>): void
获取耗电信息列表。使用callback异步回调。
**系统接口：** 此接口为系统接口。
**系统能力：** SystemCapability.PowerManager.BatteryStatistics
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback<Array<[BatteryStatsInfo](#batterystatsinfo)>> | 是 | 回调函数。当获取耗电信息列表成功，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 | 表示无线网消耗的电量类型。 |
zh-cn/application-dev/reference/apis/js-apis-brightness.md
浏览文件 @ 7e3f846f
...@@ -3,8 +3,10 @@ ...@@ -3,8 +3,10 @@
该模块提供屏幕亮度的设置接口。 该模块提供屏幕亮度的设置接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 >
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> - 本模块接口为系统接口。
## 导入模块 ## 导入模块
...@@ -18,18 +20,32 @@ setValue(value: number): void ...@@ -18,18 +20,32 @@ setValue(value: number): void
设置系统的屏幕亮度。 设置系统的屏幕亮度。
此接口为系统接口，三方应用不支持调用。 **系统接口：** 此接口为系统接口。
**系统能力：** SystemCapability.PowerManager.DisplayPowerManager **系统能力：** SystemCapability.PowerManager.DisplayPowerManager
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------- | | ------ | ------ | ---- | ----------------------- |
| value | number | 是 | 亮度的值（0~255） | | value | number | 是 | 亮度的值。范围：0~255。 |
**错误码：**
以下错误码的详细介绍请参见[屏幕亮度错误码](../errorcodes/errorcode-brightness.md)。
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4700101 | 连接服务失败。 |
**示例：** **示例：**
```js ```js
brightness.setValue(128); try {
brightness.setValue(128);
} catch(err) {
console.error('set brightness failed, err: ' + err);
}
``` ```
zh-cn/application-dev/reference/apis/js-apis-power.md
浏览文件 @ 7e3f846f
...@@ -5,21 +5,19 @@ ...@@ -5,21 +5,19 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
```js ```js
import power from '@ohos.power'; import power from '@ohos.power';
``` ```
## power.shutdown
## power.shutdownDevice shutdown(reason: string): void
shutdownDevice(reason: string): void
系统关机。 系统关机。
此接口为系统接口，三方应用不支持调用。 **系统接口：** 此接口为系统接口。
**需要权限：** ohos.permission.REBOOT **需要权限：** ohos.permission.REBOOT
...@@ -31,18 +29,32 @@ shutdownDevice(reason: string): void ...@@ -31,18 +29,32 @@ shutdownDevice(reason: string): void
| ------ | ------ | ---- | ----- | | ------ | ------ | ---- | ----- |
| reason | string | 是 | 关机原因。 | | reason | string | 是 | 关机原因。 |
**错误码：**
以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 连接服务失败。 |
**示例：** **示例：**
```js ```js
power.shutdownDevice("shutdown_test"); try {
console.info('power_shutdown_device_test success') power.shutdown('shutdown_test');
} catch(err) {
console.error('shutdown failed, err: ' + err);
}
``` ```
## power.rebootDevice<sup>(deprecated)</sup>
## power.rebootDevice
rebootDevice(reason: string): void rebootDevice(reason: string): void
> 从API version 9开始不再维护，建议使用[power.reboot](#power.reboot9)替代。
重启设备。 重启设备。
**需要权限：** ohos.permission.REBOOT **需要权限：** ohos.permission.REBOOT
...@@ -58,135 +70,196 @@ rebootDevice(reason: string): void ...@@ -58,135 +70,196 @@ rebootDevice(reason: string): void
**示例：** **示例：**
```js ```js
power.rebootDevice("reboot_test"); power.rebootDevice('reboot_test');
console.info('power_reboot_device_test success')
``` ```
## power.reboot<sup>9+</sup>
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<sup>(deprecated)</sup>
isScreenOn(callback: AsyncCallback&lt;boolean&gt;): void isScreenOn(callback: AsyncCallback&lt;boolean&gt;): void
检测当前设备的亮灭屏状态。 > 从API version 9开始不再维护，建议使用[power.isActive](#power.isactive9)替代。
检测当前设备的亮灭屏状态。使用callback异步回调。
**系统能力：** SystemCapability.PowerManager.PowerManager.Core **系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ---------------------------------------- | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 指定的callback回调方法，用于获取返回值。<br/>callback返回值：亮屏返回true，灭屏返回false。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当检测成功，err为undefined，data为获取到的亮灭屏状态，返回true表示梁平，返回false表示灭屏；否则为错误对象。 |
**示例：** **示例：**
```js ```js
power.isScreenOn((error, screenOn) => { power.isScreenOn((err, data) => {
if (typeof error === "undefined") { if (typeof err === 'undefined') {
console.info('screenOn status is ' + screenOn); console.info('screen on status is ' + data);
} else { } else {
console.log('error: ' + error); console.error('check screen status failed, err: ' + err);
} }
}) })
``` ```
## power.isScreenOn<sup>(deprecated)</sup>
## power.isScreenOn
isScreenOn(): Promise&lt;boolean&gt; isScreenOn(): Promise&lt;boolean&gt;
检测当前设备的亮灭屏状态。 > 从API version 9开始不再维护，建议使用[power.isActive](#power.isactive9)替代。
检测当前设备的亮灭屏状态。使用Promise异步回调。
**系统能力：** SystemCapability.PowerManager.PowerManager.Core **系统能力：** SystemCapability.PowerManager.PowerManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | --------------------------------------- | | ---------------------- | -------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于异步获取返回值，亮屏返回true，灭屏返回false。 | | Promise&lt;boolean&gt; | Promise对象。返回true表示亮屏；返回false表示灭屏。 |
**示例：** **示例：**
```js ```js
power.isScreenOn() power.isScreenOn()
.then(screenOn => { .then(data => {
console.info('screenOn status is ' + screenOn); console.info('screen on status is ' + data);
}) })
.catch(error => { .catch(err => {
console.log('error: ' + error); console.error('check screen status failed, err: ' + err);
}) })
``` ```
## power.wakeupDevice<sup>9+</sup> ## power.isActive<sup>9+</sup>
wakeupDevice(detail: string): void isActive(): boolean
唤醒设备。 检测当前设备是否处于活动状态。
此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.PowerManager.PowerManager.Core **系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：** **错误码：**
| 参数名 | 类型 | 必填 | 说明 | 以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。
| ------ | ------ | ---- | ---------- |
| detail | string | 是 | 唤醒原因。 | | 错误码ID | 错误信息 |
|---------|---------|
| 4900101 | 连接服务失败。 |
**示例：** **示例：**
```js ```js
power.wakeupDevice("application"); try {
console.info('power_wakeup_device_test success') var isActive = power.isActive();
} catch(err) {
console.error('check active status failed, err: ' + err);
}
``` ```
## power.suspendDevice<sup>9+</sup> ## power.wakeup<sup>9+</sup>
suspendDevice(): void wakeup(detail: string): void
休眠设备。 唤醒设备。
此接口为系统接口，三方应用不支持调用。 **系统接口：** 此接口为系统接口。
**系统能力：** SystemCapability.PowerManager.PowerManager.Core **系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- |
| detail | string | 是 | 唤醒原因。 |
**错误码：**
以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 连接服务失败。 |
**示例：** **示例：**
```js ```js
power.suspendDevice(); try {
console.info('power_suspend_device_test success') power.wakeup('wakeup_test');
} catch(err) {
console.error('wakeup failed, err: ' + err);
}
``` ```
## power.getPowerMode<sup>9+</sup> ## power.suspend<sup>9+</sup>
getPowerMode(callback: AsyncCallback&lt;DevicePowerMode&gt;): void suspend(): void
获取当前设备的电源模式。 休眠设备。
**需要权限：** ohos.permission.POWER_OPTIMIZATION **系统接口：** 此接口为系统接口。
**系统能力：** SystemCapability.PowerManager.PowerManager.Core **系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：** **错误码：**
| 参数名 | 类型 | 必填 | 说明 | 以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。
| -------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;DevicePowerMode&gt; | 是 | 指定的callback回调方法，用于获取返回值。<br/>callback返回值：[DevicePowerMode](#devicepowermode9)。 | | 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 4900101 | 连接服务失败。 |
**示例：** **示例：**
```js ```js
power.getPowerMode((error, mode) => { try {
if (typeof error === "undefined") { power.wakeup('wakeup_test');
console.info('power mode is ' + mode); } catch(err) {
} else { console.error('wakeup failed, err: ' + err);
console.log('error: ' + error); }
}
})
``` ```
## power.getPowerMode<sup>9+</sup> ## power.getPowerMode<sup>9+</sup>
getPowerMode(): Promise&lt;DevicePowerMode&gt; getPowerMode(): [DevicePowerMode](#devicepowermode9)
获取当前设备的电源模式。 获取当前设备的电源模式。
...@@ -196,29 +269,36 @@ getPowerMode(): Promise&lt;DevicePowerMode&gt; ...@@ -196,29 +269,36 @@ getPowerMode(): Promise&lt;DevicePowerMode&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------ | ------------------------------------------------------------ | | ------------------------------------ | ---------- |
| Promise&lt;DevicePowerMode&gt; | Promise实例，用于异步获取返回值，[DevicePowerMode](#devicepowermode9)。 | | [DevicePowerMode](#devicepowermode9) | 电源模式。 |
**错误码：**
以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 4900101 | 连接服务失败。 |
**示例：** **示例：**
```js ```js
power.getPowerMode() try {
.then(mode => { var mode = power.getPowerMode();
console.info('power mode is ' + mode); } catch(err) {
}) console.error('get power mode failed, err: ' + err);
.catch(error => { }
console.log('error: ' + error);
})
``` ```
## power.setPowerMode<sup>9+</sup> ## power.setPowerMode<sup>9+</sup>
setPowerMode(mode: DevicePowerMode, callback: AsyncCallback&lt;void&gt;): void setPowerMode(mode: [DevicePowerMode](#devicepowermode9), callback: AsyncCallback&lt;void&gt;): void
设置当前设备的电源模式。 设置当前设备的电源模式。使用callback异步回调。
此接口为系统接口，三方应用不支持调用。 **系统接口：** 此接口为系统接口。
**需要权限：** ohos.permission.POWER_OPTIMIZATION **需要权限：** ohos.permission.POWER_OPTIMIZATION
...@@ -226,31 +306,44 @@ setPowerMode(mode: DevicePowerMode, callback: AsyncCallback&lt;void&gt;): void ...@@ -226,31 +306,44 @@ setPowerMode(mode: DevicePowerMode, callback: AsyncCallback&lt;void&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------ | | -------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
| mode | [DevicePowerMode](#devicepowermode9) | 是 | 电源模式。 | | mode | [DevicePowerMode](#devicepowermode9) | 是 | 电源模式。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定的callback回调方法。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当设置电源模式成功，err为undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 连接服务失败。 |
**示例：** **示例：**
```js ```js
power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE, error => { try {
if (typeof error === "undefined") { power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE, err => {
console.info('set power mode to MODE_PERFORMANCE'); if (typeof err === 'undefined') {
} else { console.info('set power mode to MODE_PERFORMANCE');
console.log('error: ' + error); } else {
} console.error('set power mode failed, err: ' + err);
}) }
});
} catch(err) {
console.error('set power mode failed, err: ' + err);
}
``` ```
## power.setPowerMode<sup>9+</sup> ## power.setPowerMode<sup>9+</sup>
setPowerMode(mode: DevicePowerMode): Promise&lt;void&gt; setPowerMode(mode: DevicePowerMode): Promise&lt;void&gt;
设置当前设备的电源模式。 设置当前设备的电源模式。使用Promise异步回调。
此接口为系统接口，三方应用不支持调用。 **系统接口：** 此接口为系统接口。
**需要权限：** ohos.permission.POWER_OPTIMIZATION **需要权限：** ohos.permission.POWER_OPTIMIZATION
...@@ -264,20 +357,34 @@ setPowerMode(mode: DevicePowerMode): Promise&lt;void&gt; ...@@ -264,20 +357,34 @@ setPowerMode(mode: DevicePowerMode): Promise&lt;void&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------- | | ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise实例。 | | Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[系统电源管理错误码](../errorcodes/errorcode-power.md)。
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 链接服务失败。 |
**示例：** **示例：**
```js ```js
power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE) try {
.then(() => { power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE)
console.info('set power mode to MODE_PERFORMANCE'); .then(() => {
}) console.info('set power mode to MODE_PERFORMANCE');
.catch(error => { })
console.log('error: ' + error); .catch(err => {
}) console.error('set power mode failed, err: ' + err);
});
} catch(err) {
console.error('set power mode failed, err: ' + err);
}
``` ```
## DevicePowerMode<sup>9+</sup> ## DevicePowerMode<sup>9+</sup>
...@@ -286,7 +393,6 @@ power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE) ...@@ -286,7 +393,6 @@ power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE)
**系统能力：** SystemCapability.PowerManager.PowerManager.Core **系统能力：** SystemCapability.PowerManager.PowerManager.Core
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| ----------------------- | ------ | ---------------------- | | ----------------------- | ------ | ---------------------- |
| MODE_NORMAL | 600 | 表示标准模式，默认值。 | | MODE_NORMAL | 600 | 表示标准模式，默认值。 |
......
zh-cn/application-dev/reference/apis/js-apis-system-battery.md
浏览文件 @ 7e3f846f
# 电量信息 # 电量信息
> **说明：** 该模块提供充电状态及剩余电量的查询功能。
> - 从API Version 6开始，该接口不再维护，推荐使用新接口[`@ohos.batteryInfo`](js-apis-battery-info.md)。
> > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 从API Version 6开始不再维护，建议使用[`@ohos.batteryInfo`](js-apis-battery-info.md)替代。
## 导入模块 ## 导入模块
...@@ -16,7 +17,7 @@ import battery from '@system.battery'; ...@@ -16,7 +17,7 @@ import battery from '@system.battery';
## battery.getStatus ## battery.getStatus
getStatus(Object): void getStatus(options?: [GetStatusOptions](#getstatusoptions)): void;
获取设备当前的充电状态及剩余电量。 获取设备当前的充电状态及剩余电量。
...@@ -26,29 +27,35 @@ getStatus(Object): void ...@@ -26,29 +27,35 @@ getStatus(Object): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| success | (data: [BatteryResponse](#batteryresponse)) => void | 否 | 接口调用成功的回调函数。| | options | [GetStatusOptions](#getstatusoptions) | 否 | 包含接口调用结果的对象。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。|
| complete | () => void | 否 | 接口调用结束的回调函数。 |
**示例：** **示例：**
```js ```js
export default { battery.getStatus({
getStatus() { success: function(data) {
battery.getStatus({ console.log('success get battery level:' + data.level);
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);
fail: function(data, code) { }
console.log('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 ## BatteryResponse
包含充电状态及剩余电量的对象。
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| charging | boolean | 当前电池是否在充电中。 | | charging | boolean | 当前电池是否在充电中。 |
......
zh-cn/application-dev/reference/apis/js-apis-system-brightness.md
浏览文件 @ 7e3f846f
# 屏幕亮度 # 屏幕亮度
> **说明：** 该模块提供屏幕亮度和模式的查询、调节接口。
> - 从API Version 7 开始，该接口不再维护，推荐使用新接口[`@ohos.brightness`](js-apis-brightness.md)。
> > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
>
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 从API Version 7 开始不再维护，建议使用[`@ohos.brightness`](js-apis-brightness.md)替代。
## 导入模块 ## 导入模块
...@@ -16,7 +18,7 @@ import brightness from '@system.brightness'; ...@@ -16,7 +18,7 @@ import brightness from '@system.brightness';
## brightness.getValue ## brightness.getValue
getValue(Object): void getValue(options?: [GetBrightnessOptions](#getbrightnessoptions)): void
获得设备当前的屏幕亮度值。 获得设备当前的屏幕亮度值。
...@@ -26,38 +28,25 @@ getValue(Object): void ...@@ -26,38 +28,25 @@ getValue(Object): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| success | (data: [BrightnessResponse](#brightnessresponse)) => void | 否 | 接口调用成功的回调函数。 | | options | [GetBrightnessOptions](#getbrightnessoptions) | 否 | 获取屏幕亮度的参数对象。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 |
| complete | () => void | 否 | 接口调用结束的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| value | number | 屏幕亮度，取值为1-255之间的整数。 |
**示例：** **示例：**
```js ```js
export default { brightness.getValue({
getValue() { success: function(data) {
brightness.getValue({ console.log('success get brightness value:' + data.value);
success: function(data){ },
console.log('success get brightness value:' + data.value); fail: function(data, code) {
}, console.error('get brightness fail, code: ' + code + ', data: ' + data);
fail: function(data, code) { }
console.log('get brightness fail, code: ' + code + ', data: ' + data); });
},
});
},
}
``` ```
## brightness.setValue ## brightness.setValue
setValue(Object): void etValue(options?: [SetBrightnessOptions](#setbrightnessoptions)): void
设置设备当前的屏幕亮度值。 设置设备当前的屏幕亮度值。
...@@ -67,33 +56,26 @@ setValue(Object): void ...@@ -67,33 +56,26 @@ setValue(Object): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | number | 是 | 屏幕亮度，值为1-255之间的整数。<br/>-&nbsp;如果值小于等于0，系统按1处理。<br/>-&nbsp;如果值大于255，系统按255处理。<br/>-&nbsp;如果值为小数，系统将处理为整数。例如设置为8.1，系统按8处理。 | | options | [SetBrightnessOptions](#setbrightnessoptions) | 否 | 设置屏幕亮度的参数对象。 |
| success | () => void | 否 | 接口调用成功的回调函数。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 |
| complete | () => void | 否 | 接口调用结束的回调函数。 |
**示例：** **示例：**
```js ```js
export default { brightness.setValue({
setValue() { value: 100,
brightness.setValue({ success: function() {
value: 100, console.log('handling set brightness success.');
success: function(){ },
console.log('handling set brightness success.'); fail: function(data, code) {
}, console.error('handling set brightness value fail, code:' + code + ', data: ' + data);
fail: function(data, code){ }
console.log('handling set brightness value fail, code:' + code + ', data: ' + data); });
},
});
},
}
``` ```
## brightness.getMode ## brightness.getMode
getMode(Object): void getMode(options?: [GetBrightnessModeOptions](#getbrightnessmodeoptions): void
获得当前屏幕亮度模式。 获得当前屏幕亮度模式。
...@@ -103,37 +85,25 @@ getMode(Object): void ...@@ -103,37 +85,25 @@ getMode(Object): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| success | (data: [BrightnessModeResponse](#brightnessmoderesponse)) => void | 否 | 接口调用成功的回调函数。 | | options | [GetBrightnessModeOptions](#getbrightnessmodeoptions) | 否 | 获取屏幕亮度模式的参数对象。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 |
| complete | () => void | 否 | 接口调用结束的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| mode | number | 值为0或1：<br/>-&nbsp;0为手动调节屏幕亮度模式<br/>-&nbsp;1为自动调节屏幕亮度模式 |
**示例：** **示例：**
```js ```js
export default { brightness.getMode({
getMode() { success: function(data) {
brightness.getMode({ console.log('success get mode:' + data.mode);
success: function(data){ },
console.log('success get mode:' + data.mode); fail: function(data, code){
}, console.error('handling get mode fail, code:' + code + ', data: ' + data);
fail: function(data, code){ }
console.log('handling get mode fail, code:' + code + ', data: ' + data); });
},
});
},
}
``` ```
## brightness.setMode ## brightness.setMode
setMode(Object): void setMode(options?: [SetBrightnessModeOptions](#setbrightnessmodeoptions)): void
设置设备当前的屏幕亮度模式。 设置设备当前的屏幕亮度模式。
...@@ -142,74 +112,118 @@ setMode(Object): void ...@@ -142,74 +112,118 @@ setMode(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| mode | number | 是 | 值为0或1<br/>-&nbsp;0为手动调节屏幕亮度。<br/>-&nbsp;1为自动调节屏幕亮度。 | | options | [SetBrightnessModeOptions](#setbrightnessmodeoptions) | 否 | 设置屏幕亮度模式的参数对象。 |
| success | () => void | 否 | 接口调用成功的回调函数。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 |
| complete | () => void | 否 | 接口调用结束的回调函数。 |
**示例：** **示例：**
```js ```js
export default { brightness.setMode({
setMode() { mode: 1,
brightness.setMode({ success: function() {
mode: 1, console.log('handling set mode success.');
success: function(){ },
console.log('handling set mode success.'); fail: function(data, code) {
}, console.error('handling set mode fail, code:' + code + ', data: ' + data);
fail: function(data, code){ }
console.log('handling set mode fail, code:' + code + ', data: ' + data); });
},
});
},
}
``` ```
## brightness.setKeepScreenOn ## brightness.setKeepScreenOn
setKeepScreenOn(Object): void setKeepScreenOn(options?: [SetKeepScreenOnOptions](#setkeepscreenonoptions)): void
>从API version 7开始不再维护，建议使用[window.setKeepScreenOn](js-apis-window.md#setkeepscreenon)替代。
设置屏幕是否保持常亮状态，开启常亮模式推荐在onShow()阶段调用。 设置屏幕是否保持常亮状态，开启常亮模式推荐在onShow()阶段调用。
**系统能力：** SystemCapability.PowerManager.DisplayPowerManager **系统能力：** SystemCapability.PowerManager.DisplayPowerManager
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| keepScreenOn | boolean | 是 | 是否保持屏幕常亮。 | | options | [SetKeepScreenOnOptions](#setkeepscreenonoptions) | 否 | 设置屏幕常亮的参数对象。 |
| success | () => void | 否 | 接口调用成功的回调函数。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 |
| complete | () => void | 否 | 接口调用结束的回调函数。 |
**示例：** **示例：**
```js ```js
export default { brightness.setKeepScreenOn({
setKeepScreenOn() { keepScreenOn: true,
brightness.setKeepScreenOn({ success: function () {
keepScreenOn: true, console.log('handling set keep screen on success.');
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);
fail: function (data, code) { }
console.log('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之间的整数。<br/>-&nbsp;如果值小于等于0，系统按1处理。<br/>-&nbsp;如果值大于255，系统按255处理。<br/>-&nbsp;如果值为小数，系统将处理为整数。例如设置为8.1，系统按8处理。 |
| success | () => void | 否 | 接口调用成功的回调函数。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 |
| complete | () => void | 否 | 接口调用结束的回调函数。 |
## BrightnessResponse ## 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 ## BrightnessModeResponse
包含屏幕亮度模式的对象。
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| mode | number | 值为0或1。<br> -0为手动调节屏幕亮度模式。<br>-1为手动调节屏幕亮度模式。 | | mode | number | 0表示手动调节屏幕亮度模式，1表示自动调节屏幕亮度模式。 |
## SetKeepScreenOnOptions
设置屏幕常亮的参数对象。
| 名称 | 类型 | 必填 | 说明 |
| ------------ | ------------------------------------ | ---- | ------------------------------------------------------ |
| keepScreenOn | boolean | 是 | true表示保持屏幕常亮，false表示取消屏幕常亮。 |
| success | () => void | 否 | 接口调用成功的回调函数。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。data为错误信息，code为错误码。 |
| complete | () => void | 否 | 接口调用结束的回调函数。 |
zh-cn/application-dev/reference/apis/js-apis-thermal.md
浏览文件 @ 7e3f846f
...@@ -5,34 +5,39 @@ ...@@ -5,34 +5,39 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
```js ```js
import thermal from '@ohos.thermal'; import thermal from '@ohos.thermal';
``` ```
## thermal.subscribeThermalLevel<sup>(deprecated)</sup>
## ThermalLevel subscribeThermalLevel(callback: AsyncCallback&lt;ThermalLevel&gt;): void
热档位信息。 > 从API version 9开始不再维护，建议使用[thermal.registerThermalLevelCallback](#thermalregisterthermallevelcallback9)替代。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.PowerManager.ThermalManager 订阅热档位变化时的回调提醒。
| 名称 | 默认值 | 描述 | **系统能力：** SystemCapability.PowerManager.ThermalManager
| ---------- | ---- | ---------------------------------------- |
| COOL | 0 | 表明设备处于低温的状态，业务执行不受热控的限制。 |
| NORMAL | 1 | 表明设备处于正常工作状态，但温度不低，需要注意是否临近发热状态 |
| WARM | 2 | 表明设备已经进入温热状态，部分无感知业务需要考虑停止或延迟执行。 |
| HOT | 3 | 表明设备已经明显发热，无感知业务应全面停止，其他业务应考虑降规格及负载。 |
| OVERHEATED | 4 | 表明设备已经发热严重，无感知业务应全面停止，主要业务需降低规格及负载。 |
| WARNING | 5 | 表明设备已经发热严重并且即将进入紧急状态，无感知业务应全面停止，主要业务应降低至最低规格。 |
| EMERGENCY | 6 | 表明设备已经进入紧急状态，所有业务应当全面停止工作，可保留部分紧急求助功能。 |
**参数：**
## thermal.subscribeThermalLevel | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;ThermalLevel&gt; | 是 | 回调函数。AsyncCallback只返回一个参数，为热档位信息，此时可能会产生告警，可通过`// @ts-ignore`进行抑制。 |
subscribeThermalLevel(callback: AsyncCallback&lt;ThermalLevel&gt;): void **示例：**
```js
thermal.subscribeThermalLevel((level) => {
console.info('thermal level is: ' + level);
});
```
## thermal.registerThermalLevelCallback<sup>9+</sup>
registerThermalLevelCallback(callback: Callback&lt;ThermalLevel&gt;): void
订阅热档位变化时的回调提醒。 订阅热档位变化时的回调提醒。
...@@ -40,45 +45,98 @@ subscribeThermalLevel(callback: AsyncCallback&lt;ThermalLevel&gt;): void ...@@ -40,45 +45,98 @@ subscribeThermalLevel(callback: AsyncCallback&lt;ThermalLevel&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | ---------------------------------------- | | -------- | ---------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback&lt;ThermalLevel&gt; | 是 | 指定的callback回调方法，用于获取返回值。<br/>AsyncCallback只返回一个参数，为热档位信息，此时可能会产生告警，可通过`// @ts-ignore`进行抑制。 | | callback | Callback&lt;ThermalLevel&gt; | 是 | 回调函数，返回变化后的热档位。 |
**错误码：**
以下错误码的详细介绍请参见[耗电统计错误码](../errorcodes/errorcode-thermal.md)。
| 错误码ID | 错误信息 |
|---------|---------|
| 401 | 参数检查失败。 |
| 4800101 | 连接服务失败。 |
**示例：** **示例：**
```js ```js
var lev = 0; try {
thermal.subscribeThermalLevel((lev) => { thermal.registerThermalLevelCallback(level => {
console.info("Thermal level is: " + lev); 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<sup>(deprecated)</sup>
unsubscribeThermalLevel(callback?: AsyncCallback\<void>): void unsubscribeThermalLevel(callback?: AsyncCallback\<void>): void
> 从API version 9开始不再维护，建议使用[thermal.unregisterThermalLevelCallback](#thermalunregisterthermallevelcallback9)替代。
取消订阅热档位变化时的回调提醒。 取消订阅热档位变化时的回调提醒。
**系统能力：** SystemCapability.PowerManager.ThermalManager **系统能力：** SystemCapability.PowerManager.ThermalManager
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------------- | | -------- | ------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback&lt;void&gt; | 可选 | 指定的callback回调方法，无返回值。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数，无返回值。不填该参数则取消所有回调。 |
**示例：** **示例：**
```js ```js
thermal.unsubscribeThermalLevel(() => { thermal.unsubscribeThermalLevel(() => {
console.info("Unsubscribe completed."); console.info('unsubscribe thermal level success.');
}); });
``` ```
## thermal.getThermalLevel ## thermal.unregisterThermalLevelCallback<sup>9+</sup>
unregisterThermalLevelCallback(callback?: Callback\<void>): void
取消订阅热档位变化时的回调提醒。
**系统能力：** SystemCapability.PowerManager.ThermalManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------------- |
| callback | Callback&lt;void&gt; | 可选 | 回调函数，无返回值。不填该参数则取消所有回调。 |
**错误码：**
以下错误码的详细介绍请参见[热管理错误码](../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<sup>(deprecated)</sup>
getThermalLevel(): ThermalLevel getThermalLevel(): ThermalLevel
> 从API version 9开始不再维护，建议使用[thermal.getLevel](#thermalgetlevel9)替代。
获取当前热档位信息。 获取当前热档位信息。
**系统能力：** SystemCapability.PowerManager.ThermalManager **系统能力：** SystemCapability.PowerManager.ThermalManager
...@@ -92,6 +150,55 @@ getThermalLevel(): ThermalLevel ...@@ -92,6 +150,55 @@ getThermalLevel(): ThermalLevel
**示例：** **示例：**
```js ```js
var lev = thermal.getThermalLevel(); var level = thermal.getThermalLevel();
console.info("Thermal level is: " + lev); console.info('thermal level is: ' + level);
``` ```
## thermal.getLevel<sup>9+</sup>
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 | 表明设备已经进入紧急状态，所有业务应当全面停止工作，可保留部分紧急求助功能。 |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或