Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
db640964
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
db640964
编写于
10月 19, 2022
作者:
O
openharmony_ci
提交者:
Gitee
10月 19, 2022
浏览文件
操作
浏览文件
下载
差异文件
!10722 feat: 电源管理子系统支持异常,更新参考和错误码
Merge pull request !10722 from Zhangchunxin/feat_errcode
上级
7c15235f
bf8d5545
变更
13
展开全部
隐藏空白更改
内联
并排
Showing
13 changed file
with
1322 addition
and
413 deletion
+1322
-413
zh-cn/application-dev/reference/apis/js-apis-battery-info.md
zh-cn/application-dev/reference/apis/js-apis-battery-info.md
+27
-33
zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md
...plication-dev/reference/apis/js-apis-batteryStatistics.md
+287
-0
zh-cn/application-dev/reference/apis/js-apis-brightness.md
zh-cn/application-dev/reference/apis/js-apis-brightness.md
+21
-7
zh-cn/application-dev/reference/apis/js-apis-power.md
zh-cn/application-dev/reference/apis/js-apis-power.md
+205
-117
zh-cn/application-dev/reference/apis/js-apis-runninglock.md
zh-cn/application-dev/reference/apis/js-apis-runninglock.md
+340
-102
zh-cn/application-dev/reference/apis/js-apis-system-battery.md
.../application-dev/reference/apis/js-apis-system-battery.md
+27
-20
zh-cn/application-dev/reference/apis/js-apis-system-brightness.md
...plication-dev/reference/apis/js-apis-system-brightness.md
+118
-105
zh-cn/application-dev/reference/apis/js-apis-thermal.md
zh-cn/application-dev/reference/apis/js-apis-thermal.md
+134
-29
zh-cn/application-dev/reference/errorcodes/errorcode-batteryStatistics.md
...n-dev/reference/errorcodes/errorcode-batteryStatistics.md
+29
-0
zh-cn/application-dev/reference/errorcodes/errorcode-brightness.md
...lication-dev/reference/errorcodes/errorcode-brightness.md
+29
-0
zh-cn/application-dev/reference/errorcodes/errorcode-power.md
...n/application-dev/reference/errorcodes/errorcode-power.md
+47
-0
zh-cn/application-dev/reference/errorcodes/errorcode-runninglock.md
...ication-dev/reference/errorcodes/errorcode-runninglock.md
+29
-0
zh-cn/application-dev/reference/errorcodes/errorcode-thermal.md
...application-dev/reference/errorcodes/errorcode-thermal.md
+29
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-battery-info.md
浏览文件 @
db640964
...
...
@@ -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摄氏度。 |
| isBatteryPresent
<sup>
7+
</sup>
| boolean | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 |
| batteryCapacityLevel
<sup>
9+
</sup>
|
[
BatteryCapacityLevel
](
#batterycapacitylevel9
)
| 是 | 否 | 表示当前设备电池电量的等级。 |
| estimatedRemainingChargeTime
<sup>
9+
</sup>
| number | 是 | 否 | 表示当前设备充满电的预估时间,单位毫秒。 |
| totalEnergy
<sup>
9+
</sup>
| number | 是 | 否 | 表示当前设备电池的总容量,单位毫安时。此接口为系统接口,三方应用不支持调用。 |
| nowCurrent
<sup>
9+
</sup>
| number | 是 | 否 | 表示当前设备电池的电流,单位毫安。此接口为系统接口,三方应用不支持调用。 |
| remainingEnergy
<sup>
9+
</sup>
| 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摄氏度。 |
| isBatteryPresent
<sup>
7+
</sup>
| boolean | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 |
| batteryCapacityLevel
<sup>
9+
</sup>
|
[
BatteryCapacityLevel
](
#batterycapacitylevel9
)
| 是 | 否 | 表示当前设备电池电量的等级。 |
| estimatedRemainingChargeTime
<sup>
9+
</sup>
| number | 是 | 否 | 表示当前设备充满电的预估时间,单位毫秒。 |
| totalEnergy
<sup>
9+
</sup>
| number | 是 | 否 | 表示当前设备电池的总容量,单位毫安时。此接口为系统接口。 |
| nowCurrent
<sup>
9+
</sup>
| number | 是 | 否 | 表示当前设备电池的电流,单位毫安。此接口为系统接口。 |
| remainingEnergy
<sup>
9+
</sup>
| number | 是 | 否 | 表示当前设备电池的剩余容量,单位毫安时。此接口为系统接口。 |
## BatteryPluggedType
...
...
@@ -105,22 +99,22 @@ import batteryInfo from '@ohos.batteryInfo';
## CommonEventBatteryChangedCode<sup>9+</sup>
表示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 | 表示当前设备电池技术型号的
查询键
。 |
zh-cn/application-dev/reference/apis/js-apis-batteryStatistics.md
0 → 100644
浏览文件 @
db640964
# 耗电统计
该模块提供软硬件耗电统计信息的查询接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口为系统接口。
## 导入模块
```
js
import
batteryStats
from
'
@ohos.batteryStatistics
'
;
```
## batteryStats.getBatteryStats
getBatteryStats(): Promise
<Array
&
lt
;
BatteryStatsInfo
&
gt
;
>
获取耗电信息列表。使用Promise异步回调。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.PowerManager.BatteryStatistics
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------------- | ------------------------------- |
| Promise
<Array
<[
BatteryStatsInfo
](
#batterystatsinfo
)
>
> | Promise对象,返回耗电信息列表。 |
**错误码:**
以下错误码的详细介绍请参见
[
耗电统计错误码
](
../errorcodes/errorcode-batteryStatistics.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 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
&
lt
;
BatteryStatsInfo
&
gt
;
>
): void
获取耗电信息列表。使用callback异步回调。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.PowerManager.BatteryStatistics
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback
<Array
<[
BatteryStatsInfo
](
#batterystatsinfo
)
>
> | 是 | 回调函数。当获取耗电信息列表成功,err为undefined,data为获取到的Array
<
[
BatteryStatsInfo
](
#batterystatsinfo
)
>
>;否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见
[
耗电统计错误码
](
../errorcodes/errorcode-batteryStatistics.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 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 | 错误信息 |
|---------|---------|
| 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 | 错误信息 |
|---------|---------|
| 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): number
根据耗电类型获取硬件单元的耗电量。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.PowerManager.BatteryStatistics
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | ---- | -------------- |
| type |
[
ConsumptionType
](
#consumptiontype
)
| 是 | 电量消耗类型。 |
**返回值:**
| 类型 | 说明 |
| ------ | ------------------------------------------ |
| number | 电量消耗类型对应硬件的耗电量,单位毫安时。 |
**错误码:**
以下错误码的详细介绍请参见
[
耗电统计错误码
](
../errorcodes/errorcode-batteryStatistics.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 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): number
根据耗电类型获取硬件单元的耗电百分比。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.PowerManager.BatteryStatistics
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | ---- | -------------- |
| type |
[
ConsumptionType
](
#consumptiontype
)
| 是 | 电量消耗类型。 |
**返回值:**
| 类型 | 说明 |
| ------ | ---------------------------------- |
| number | 电量消耗类型对应硬件的耗电百分比。 |
**错误码:**
以下错误码的详细介绍请参见
[
耗电统计错误码
](
../errorcodes/errorcode-batteryStatistics.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 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
浏览文件 @
db640964
...
...
@@ -3,8 +3,10 @@
该模块提供屏幕亮度的设置接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口为系统接口。
## 导入模块
...
...
@@ -18,18 +20,30 @@ setValue(value: number): void
设置系统的屏幕亮度。
此接口为系统接口,三方应用不支持调用
。
**系统接口:**
此接口为系统接口
。
**系统能力:**
SystemCapability.PowerManager.DisplayPowerManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------- |
| value | number | 是 | 亮度的值(0~255) |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----------------------- |
| value | number | 是 | 亮度的值。范围:0~255。 |
**错误码:**
以下错误码的详细介绍请参见
[
屏幕亮度错误码
](
../errorcodes/errorcode-brightness.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 4700101 | 连接服务失败。 |
**示例:**
```
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
浏览文件 @
db640964
...
...
@@ -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,135 +29,191 @@ shutdownDevice(reason: string): void
| ------ | ------ | ---- | ----- |
| reason | string | 是 | 关机原因。 |
**错误码:**
以下错误码的详细介绍请参见
[
系统电源管理错误码
](
../errorcodes/errorcode-power.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 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.reboot<sup>9+</sup>
## power.rebootDevice
rebootDevice(reason: string): void
reboot(reason: string): void
重启设备。
**系统接口:**
此接口为系统接口。
**需要权限:**
ohos.permission.REBOOT
**系统能力:**
SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- |
| reason | string | 是 | 重启原因。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- |
| reason | string | 是 | 重启原因。 |
**错误码:**
以下错误码的详细介绍请参见
[
系统电源管理错误码
](
../errorcodes/errorcode-power.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 4900101 | 连接服务失败。 |
**示例:**
```
js
power
.
rebootDevice
(
"
reboot_test
"
);
console
.
info
(
'
power_reboot_device_test success
'
)
try
{
power
.
reboot
(
'
reboot_test
'
);
}
catch
(
err
)
{
console
.
error
(
'
reboot failed, err:
'
+
err
);
}
```
## power.isActive<sup>9+</sup>
## power.isScreenO
n
isActive(): boolea
n
isScreenOn(callback: AsyncCallback
<
boolean
>
): void
检测当前设备的亮灭屏状态。
检测当前设备是否处于活动状态。
**系统能力:**
SystemCapability.PowerManager.PowerManager.Core
**参数:**
**错误码:**
以下错误码的详细介绍请参见
[
系统电源管理错误码
](
../errorcodes/errorcode-power.md
)
。
|
参数名 | 类型 | 必填 | 说明
|
|
-------- | ---------------------------- | ---- | ----------------------------------------
|
|
callback | AsyncCallback
<
boolean
>
| 是 | 指定的callback回调方法,用于获取返回值。
<br/>
callback返回值:亮屏返回true,灭屏返回false
。 |
|
错误码ID | 错误信息
|
|
---------|---------
|
|
4900101 | 连接服务失败
。 |
**示例:**
```
js
power
.
isScreenOn
((
error
,
screenOn
)
=>
{
if
(
typeof
error
===
"
undefined
"
)
{
console
.
info
(
'
screenOn status is
'
+
screenOn
);
}
else
{
console
.
log
(
'
error:
'
+
error
);
}
})
try
{
var
isActive
=
power
.
isActive
();
console
.
info
(
'
power is active:
'
+
isActive
);
}
catch
(
err
)
{
console
.
error
(
'
check active status failed, err:
'
+
err
);
}
```
## power.wakeup<sup>9+</sup>
## power.isScreenOn
wakeup(detail: string): void
isScreenOn(): Promise
<
boolean
>
唤醒设备。
检测当前设备的亮灭屏状态
。
**系统接口:**
此接口为系统接口
。
**系统能力:**
SystemCapability.PowerManager.PowerManager.Core
**返回值:**
| 类型 | 说明 |
| ---------------------- | --------------------------------------- |
| Promise
<
boolean
>
| Promise实例,用于异步获取返回值,亮屏返回true,灭屏返回false。 |
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- |
| detail | string | 是 | 唤醒原因。 |
**错误码:**
以下错误码的详细介绍请参见
[
系统电源管理错误码
](
../errorcodes/errorcode-power.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 4900101 | 连接服务失败。 |
**示例:**
```
js
power
.
isScreenOn
()
.
then
(
screenOn
=>
{
console
.
info
(
'
screenOn status is
'
+
screenOn
);
})
.
catch
(
error
=>
{
console
.
log
(
'
error:
'
+
error
);
})
try
{
power
.
wakeup
(
'
wakeup_test
'
);
}
catch
(
err
)
{
console
.
error
(
'
wakeup failed, err:
'
+
err
);
}
```
## power.
wakeupDevice
<sup>9+</sup>
## power.
suspend
<sup>9+</sup>
wakeupDevice(detail: string
): void
suspend(
): void
唤醒
设备。
休眠
设备。
此接口为系统接口,三方应用不支持调用
。
**系统接口:**
此接口为系统接口
。
**系统能力:**
SystemCapability.PowerManager.PowerManager.Core
**
参数
:**
**
错误码
:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- |
| detail | string | 是 | 唤醒原因。 |
以下错误码的详细介绍请参见
[
系统电源管理错误码
](
../errorcodes/errorcode-power.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 4900101 | 连接服务失败。 |
**示例:**
```
js
power
.
wakeupDevice
(
"
application
"
);
console
.
info
(
'
power_wakeup_device_test success
'
)
try
{
power
.
suspend
();
}
catch
(
err
)
{
console
.
error
(
'
suspend failed, err:
'
+
err
);
}
```
## power.
suspendDevic
e<sup>9+</sup>
## power.
getPowerMod
e<sup>9+</sup>
suspendDevice(): void
getPowerMode(): DevicePowerMode
休眠设备
。
获取当前设备的电源模式
。
此接口为系统接口,三方应用不支持调用。
**需要权限:**
ohos.permission.POWER_OPTIMIZATION
**系统能力:**
SystemCapability.PowerManager.PowerManager.Core
**返回值:**
| 类型 | 说明 |
| ------------------------------------ | ---------- |
|
[
DevicePowerMode
](
#devicepowermode9
)
| 电源模式。 |
**错误码:**
以下错误码的详细介绍请参见
[
系统电源管理错误码
](
../errorcodes/errorcode-power.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 4900101 | 连接服务失败。 |
**示例:**
```
js
power
.
suspendDevice
();
console
.
info
(
'
power_suspend_device_test success
'
)
try
{
var
mode
=
power
.
getPowerMode
();
console
.
info
(
'
power mode:
'
+
mode
);
}
catch
(
err
)
{
console
.
error
(
'
get power mode failed, err:
'
+
err
);
}
```
## power.getPowerMode<sup>9+</sup>
## power.setPowerMode<sup>9+</sup>
setPowerMode(mode: DevicePowerMode, callback: AsyncCallback
<
void
>
): void
getPowerMode(callback: AsyncCallback
<
DevicePowerMode
>
): void
设置当前设备的电源模式。使用callback异步回调。
获取当前设备的电源模式
。
**系统接口:**
此接口为系统接口
。
**需要权限:**
ohos.permission.POWER_OPTIMIZATION
...
...
@@ -169,114 +223,149 @@ getPowerMode(callback: AsyncCallback<DevicePowerMode>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback
<
DevicePowerMode
>
| 是 | 指定的callback回调方法,用于获取返回值。
<br/>
callback返回值:
[
DevicePowerMode
](
#devicepowermode9
)
。 |
| mode |
[
DevicePowerMode
](
#devicepowermode9
)
| 是 | 电源模式。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当设置电源模式成功,err为undefined,否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见
[
系统电源管理错误码
](
../errorcodes/errorcode-power.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 4900101 | 连接服务失败。 |
**示例:**
```
js
power
.
getPowerMode
((
error
,
mode
)
=>
{
if
(
typeof
err
or
===
"
undefined
"
)
{
console
.
info
(
'
power mode is
'
+
mode
);
power
.
setPowerMode
(
power
.
DevicePowerMode
.
MODE_PERFORMANCE
,
err
=>
{
if
(
typeof
err
===
'
undefined
'
)
{
console
.
info
(
'
set power mode to MODE_PERFORMANCE
'
);
}
else
{
console
.
log
(
'
error:
'
+
erro
r
);
console
.
error
(
'
set power mode failed, err:
'
+
er
r
);
}
})
})
;
```
## power.setPowerMode<sup>9+</sup>
## power.getPowerMode<sup>9+</sup>
setPowerMode(mode: DevicePowerMode): Promise
<
void
>
getPowerMode(): Promise
<
DevicePowerMode
>
设置当前设备的电源模式。使用Promise异步回调。
获取当前设备的电源模式
。
**系统接口:**
此接口为系统接口
。
**需要权限:**
ohos.permission.POWER_OPTIMIZATION
**系统能力:**
SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------------ | ---- | ---------- |
| mode |
[
DevicePowerMode
](
#devicepowermode9
)
| 是 | 电源模式。 |
**返回值:**
| 类型 | 说明 |
| ------------------------------ | ------------------------------------------------------------ |
| Promise
<
DevicePowerMode
>
| Promise实例,用于异步获取返回值,
[
DevicePowerMode
](
#devicepowermode9
)
。 |
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise
<
void
>
| Promise对象。无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见
[
系统电源管理错误码
](
../errorcodes/errorcode-power.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 4900101 | 链接服务失败。 |
**示例:**
```
js
power
.
getPowerMode
()
.
then
(
mode
=>
{
console
.
info
(
'
power mode is
'
+
mode
);
})
.
catch
(
error
=>
{
console
.
log
(
'
error:
'
+
error
);
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
);
});
```
## power.
setPowerMode<sup>9+
</sup>
## power.
rebootDevice<sup>(deprecated)
</sup>
setPowerMode(mode: DevicePowerMode, callback: AsyncCallback
<
void
>
): void
rebootDevice(reason: string
): void
设置当前设备的电源模式
。
> 从API version 9开始不再维护,建议使用[power.reboot](#powerreboot9)替代
。
此接口为系统接口,三方应用不支持调用
。
重启设备
。
**需要权限:**
ohos.permission.
POWER_OPTIMIZATION
**需要权限:**
ohos.permission.
REBOOT
**系统能力:**
SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------ |
| mode |
[
DevicePowerMode
](
#devicepowermode9
)
| 是 | 电源模式。 |
| callback | AsyncCallback
<
void
>
| 是 | 指定的callback回调方法。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- |
| reason | string | 是 | 重启原因。 |
**示例:**
```
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
);
}
})
power
.
rebootDevice
(
'
reboot_test
'
);
```
## power.isScreenOn<sup>(deprecated)</sup>
## power.setPowerMode<sup>9+</sup>
setPowerMode(mode: DevicePowerMode): Promise
<
void
>
设置当前设备的电源模式。
isScreenOn(callback: AsyncCallback
<
boolean
>
): void
此接口为系统接口,三方应用不支持调用
。
> 从API version 9开始不再维护,建议使用[power.isActive](#powerisactive9)替代
。
**需要权限:**
ohos.permission.POWER_OPTIMIZATION
检测当前设备的亮灭屏状态。使用callback异步回调。
**系统能力:**
SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ------
| ------------------------------------ | ---- |
---------- |
|
mode |
[
DevicePowerMode
](
#devicepowermode9
)
| 是 | 电源模式
。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------
-- | ---------------------------- | ---- | --------------------------------------------------
---------- |
|
callback | AsyncCallback
<
boolean
>
| 是 | 回调函数。当检测成功,err为undefined,data为获取到的亮灭屏状态,返回true表示梁平,返回false表示灭屏;否则为错误对象
。 |
**
返回值
:**
**
示例
:**
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise
<
void
>
| Promise实例。 |
```
js
power
.
isScreenOn
((
err
,
data
)
=>
{
if
(
typeof
err
===
'
undefined
'
)
{
console
.
info
(
'
screen on status is
'
+
data
);
}
else
{
console
.
error
(
'
check screen status failed, err:
'
+
err
);
}
})
```
## power.isScreenOn<sup>(deprecated)</sup>
isScreenOn(): Promise
<
boolean
>
> 从API version 9开始不再维护,建议使用[power.isActive](#powerisactive9)替代。
检测当前设备的亮灭屏状态。使用Promise异步回调。
**系统能力:**
SystemCapability.PowerManager.PowerManager.Core
**返回值:**
| 类型 | 说明 |
| ---------------------- | -------------------------------------------------- |
| Promise
<
boolean
>
| Promise对象。返回true表示亮屏;返回false表示灭屏。 |
**示例:**
```
js
power
.
setPowerMode
(
power
.
DevicePowerMode
.
MODE_PERFORMANCE
)
.
then
(
()
=>
{
console
.
info
(
'
s
et power mode to MODE_PERFORMANCE
'
);
power
.
isScreenOn
(
)
.
then
(
data
=>
{
console
.
info
(
'
s
creen on status is
'
+
data
);
})
.
catch
(
err
or
=>
{
console
.
log
(
'
error:
'
+
erro
r
);
.
catch
(
err
=>
{
console
.
error
(
'
check screen status failed, err:
'
+
er
r
);
})
```
...
...
@@ -286,7 +375,6 @@ power.setPowerMode(power.DevicePowerMode.MODE_PERFORMANCE)
**系统能力:**
SystemCapability.PowerManager.PowerManager.Core
| 名称 | 默认值 | 描述 |
| ----------------------- | ------ | ---------------------- |
| MODE_NORMAL | 600 | 表示标准模式,默认值。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-runninglock.md
浏览文件 @
db640964
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-system-battery.md
浏览文件 @
db640964
# 电量信息
> **说明:**
> - 从API Version 6开始,该接口不再维护,推荐使用新接口[`@ohos.batteryInfo`](js-apis-battery-info.md)。
>
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
该模块提供充电状态及剩余电量的查询功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 从API Version 6开始不再维护,建议使用[`@ohos.batteryInfo`](js-apis-battery-info.md)替代。
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
...
...
@@ -16,7 +17,7 @@ import battery from '@system.battery';
## battery.getStatus
getStatus(
Object): void
getStatus(
options?: 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 | 当前电池是否在充电中。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-system-brightness.md
浏览文件 @
db640964
# 屏幕亮度
> **说明:**
> - 从API Version 7 开始,该接口不再维护,推荐使用新接口[`@ohos.brightness`](js-apis-brightness.md)。
>
该模块提供屏幕亮度和模式的查询、调节接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 从API Version 7 开始不再维护,建议使用[`@ohos.brightness`](js-apis-brightness.md)替代。
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
@@ -16,7 +17,7 @@ import brightness from '@system.brightness';
## brightness.getValue
getValue(
Object
): void
getValue(
options?: GetBrightnessOptions
): void
获得设备当前的屏幕亮度值。
...
...
@@ -26,38 +27,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
): void
设置设备当前的屏幕亮度值。
...
...
@@ -67,33 +55,26 @@ setValue(Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | number | 是 | 屏幕亮度,值为1-255之间的整数。
<br/>
-
如果值小于等于0,系统按1处理。
<br/>
-
如果值大于255,系统按255处理。
<br/>
-
如果值为小数,系统将处理为整数。例如设置为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
: void
获得当前屏幕亮度模式。
...
...
@@ -103,37 +84,25 @@ getMode(Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| success | (data:
[
BrightnessModeResponse
](
#brightnessmoderesponse
)
) => void | 否 | 接口调用成功的回调函数。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 |
| complete | () => void | 否 | 接口调用结束的回调函数。 |
success返回值:
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| mode | number | 值为0或1:
<br/>
-
0为手动调节屏幕亮度模式
<br/>
-
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
): void
设置设备当前的屏幕亮度模式。
...
...
@@ -142,74 +111,118 @@ setMode(Object): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mode | number | 是 | 值为0或1
<br/>
-
0为手动调节屏幕亮度。
<br/>
-
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): 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之间的整数。
<br/>
-
如果值小于等于0,系统按1处理。
<br/>
-
如果值大于255,系统按255处理。
<br/>
-
如果值为小数,系统将处理为整数。例如设置为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。
<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
浏览文件 @
db640964
...
...
@@ -5,80 +5,169 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
js
import
thermal
from
'
@ohos.thermal
'
;
```
## thermal.registerThermalLevelCallback<sup>9+</sup>
## ThermalLevel
registerThermalLevelCallback(callback: Callback
<
ThermalLevel
>
): void
热档位信息。
订阅热档位变化时的回调提醒。
**系统能力:**
SystemCapability.PowerManager.ThermalManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------ |
| callback | Callback
<
ThermalLevel
>
| 是 | 回调函数,返回变化后的热档位。 |
**错误码:**
以下错误码的详细介绍请参见
[
耗电统计错误码
](
../errorcodes/errorcode-thermal.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 4800101 | 连接服务失败。 |
**示例:**
```
js
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.unregisterThermalLevelCallback<sup>9+</sup>
unregisterThermalLevelCallback(callback?: Callback
\<
void>): void
取消订阅热档位变化时的回调提醒。
**系统能力:**
SystemCapability.PowerManager.ThermalManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------------- |
| callback | Callback
<
void
>
| 可选 | 回调函数,无返回值。不填该参数则取消所有回调。 |
**错误码:**
以下错误码的详细介绍请参见
[
热管理错误码
](
../errorcodes/errorcode-thermal.md
)
。
| 错误码ID | 错误信息 |
|---------|---------|
| 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.getLevel<sup>9+</sup>
getLevel(): ThermalLevel
获取当前热档位信息。
**系统能力:**
SystemCapability.PowerManager.ThermalManager
**返回值:**
| 类型 | 说明 |
| ------------ | ------------ |
| ThermalLevel | 热档位信息。 |
**错误码:**
**系统能力:**
以下各项对应的系统能力均为SystemCapability.PowerManager.ThermalManager
以下错误码的详细介绍请参见
[
热管理错误码
](
../errorcodes/errorcode-thermal.md
)
。
| 名称 | 默认值 | 描述 |
| ---------- | ---- | ---------------------------------------- |
| COOL | 0 | 表明设备处于低温的状态,业务执行不受热控的限制。 |
| NORMAL | 1 | 表明设备处于正常工作状态,但温度不低,需要注意是否临近发热状态 |
| WARM | 2 | 表明设备已经进入温热状态,部分无感知业务需要考虑停止或延迟执行。 |
| HOT | 3 | 表明设备已经明显发热,无感知业务应全面停止,其他业务应考虑降规格及负载。 |
| OVERHEATED | 4 | 表明设备已经发热严重,无感知业务应全面停止,主要业务需降低规格及负载。 |
| WARNING | 5 | 表明设备已经发热严重并且即将进入紧急状态,无感知业务应全面停止,主要业务应降低至最低规格。 |
| EMERGENCY | 6 | 表明设备已经进入紧急状态,所有业务应当全面停止工作,可保留部分紧急求助功能。 |
| 错误码ID | 错误信息 |
|---------|---------|
| 4800101 | 连接服务失败。 |
**示例:**
```
js
try
{
var
level
=
thermal
.
getLevel
();
console
.
info
(
'
thermal level is:
'
+
level
);
}
catch
(
err
)
{
console
.
error
(
'
get thermal level failed, err:
'
+
err
);
}
```
## thermal.subscribeThermalLevel
## thermal.subscribeThermalLevel
<sup>(deprecated)</sup>
subscribeThermalLevel(callback: AsyncCallback
<
ThermalLevel
>
): void
> 从API version 9开始不再维护,建议使用[thermal.registerThermalLevelCallback](#thermalregisterthermallevelcallback9)替代。
订阅热档位变化时的回调提醒。
**系统能力:**
SystemCapability.PowerManager.ThermalManager
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback
<
ThermalLevel
>
| 是
| 指定的callback回调方法,用于获取返回值。
<br/>
AsyncCallback只返回一个参数,为热档位信息,此时可能会产生告警,可通过
`// @ts-ignore`
进行抑制。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------------- | ---- | ----------------------------------------
--------------------
|
| callback | AsyncCallback
<
ThermalLevel
>
| 是
| 回调函数。
AsyncCallback只返回一个参数,为热档位信息,此时可能会产生告警,可通过
`// @ts-ignore`
进行抑制。 |
**示例:**
```
js
var
lev
=
0
;
thermal
.
subscribeThermalLevel
((
lev
)
=>
{
console
.
info
(
"
Thermal level is:
"
+
lev
);
})
thermal
.
subscribeThermalLevel
((
level
)
=>
{
console
.
info
(
'
thermal level is:
'
+
level
);
});
```
## thermal.unsubscribeThermalLevel
## thermal.unsubscribeThermalLevel
<sup>(deprecated)</sup>
unsubscribeThermalLevel(callback?: AsyncCallback
\<
void>): 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.getThermalLevel
<sup>(deprecated)</sup>
getThermalLevel(): ThermalLevel
> 从API version 9开始不再维护,建议使用[thermal.getLevel](#thermalgetlevel9)替代。
获取当前热档位信息。
**系统能力:**
SystemCapability.PowerManager.ThermalManager
...
...
@@ -92,6 +181,22 @@ getThermalLevel(): ThermalLevel
**示例:**
```
js
var
lev
=
thermal
.
getThermalLevel
();
console
.
info
(
"
Thermal level is:
"
+
lev
);
var
lev
el
=
thermal
.
getThermalLevel
();
console
.
info
(
'
thermal level is:
'
+
level
);
```
## ThermalLevel
热档位信息。
**系统能力:**
SystemCapability.PowerManager.ThermalManager
| 名称 | 默认值 | 描述 |
| ---------- | ------ | ------------------------------------------------------------ |
| COOL | 0 | 表明设备处于低温的状态,业务执行不受热控的限制。 |
| NORMAL | 1 | 表明设备处于正常工作状态,但温度不低,需要注意是否临近发热状态 |
| WARM | 2 | 表明设备已经进入温热状态,部分无感知业务需要考虑停止或延迟执行。 |
| HOT | 3 | 表明设备已经明显发热,无感知业务应全面停止,其他业务应考虑降规格及负载。 |
| OVERHEATED | 4 | 表明设备已经发热严重,无感知业务应全面停止,主要业务需降低规格及负载。 |
| WARNING | 5 | 表明设备已经发热严重并且即将进入紧急状态,无感知业务应全面停止,主要业务应降低至最低规格。 |
| EMERGENCY | 6 | 表明设备已经进入紧急状态,所有业务应当全面停止工作,可保留部分紧急求助功能。 |
zh-cn/application-dev/reference/errorcodes/errorcode-batteryStatistics.md
0 → 100644
浏览文件 @
db640964
# 耗电统计错误码
## 4600101 连接服务失败
**错误信息**
Operation failed. Cannot connect to service.
**错误描述**
操作失败,连接系统服务发生异常。
**可能原因**
1.
系统服务停止运行。
2.
系统服务内部通讯发生异常。
**处理步骤**
检查系统服务是否正常运行。
1.
在控制台中输入如下命令,查看当前的系统服务列表。
```bash
> hdc shell hidumper -ls
```
2.
查看系统服务列表中是否包含BatteryStatisticsService系统服务。
zh-cn/application-dev/reference/errorcodes/errorcode-brightness.md
0 → 100644
浏览文件 @
db640964
# 屏幕亮度错误码
## 4700101 连接服务失败
**错误信息**
Operation failed. Cannot connect to service.
**错误描述**
操作失败,连接系统服务发生异常。
**可能原因**
1.
系统服务停止运行。
2.
系统服务内部通讯发生异常。
**处理步骤**
检查系统服务是否正常运行。
1.
在控制台中输入如下命令,查看当前的系统服务列表。
```bash
> hdc shell hidumper -ls
```
2.
查看系统服务列表中是否包含DisplayPowerManagerService系统服务。
zh-cn/application-dev/reference/errorcodes/errorcode-power.md
0 → 100644
浏览文件 @
db640964
# 系统电源管理错误码
## 4900101 连接服务失败
**错误信息**
Operation failed. Cannot connect to service.
**错误描述**
操作失败,连接系统服务发生异常。
**可能原因**
1.
系统服务停止运行。
2.
系统服务内部通讯发生异常。
**处理步骤**
检查系统服务是否正常运行。
1.
在控制台中输入如下命令,查看当前的系统服务列表。
```bash
> hdc shell hidumper -ls
```
2.
查看系统服务列表中是否包含PowerManagerService系统服务。
## 4900102 正在关机中
**错误信息**
Operation failed. System is shutting down.
**错误描述**
操作失败,系统正在关机。
**可能原因**
系统正在处于关机过程中。
**处理步骤**
在系统正常运行的状态下进行操作。
zh-cn/application-dev/reference/errorcodes/errorcode-runninglock.md
0 → 100644
浏览文件 @
db640964
# RunningLock锁错误码
## 4900101 连接服务失败
**错误信息**
Operation failed. Cannot connect to service.
**错误描述**
操作失败,连接系统服务发生异常。
**可能原因**
1.
系统服务停止运行。
2.
系统服务内部通讯发生异常。
**处理步骤**
检查系统服务是否正常运行。
1.
在控制台中输入如下命令,查看当前的系统服务列表。
```bash
> hdc shell hidumper -ls
```
2.
查看系统服务列表中是否包含PowerManagerService系统服务。
zh-cn/application-dev/reference/errorcodes/errorcode-thermal.md
0 → 100644
浏览文件 @
db640964
# 热管理错误码
## 4800101 连接服务失败
**错误信息**
Operation failed. Cannot connect to service.
**错误描述**
操作失败,连接系统服务发生异常。
**可能原因**
1.
系统服务停止运行。
2.
系统服务内部通讯发生异常。
**处理步骤**
检查系统服务是否正常运行。
1.
在控制台中输入如下命令,查看当前的系统服务列表。
```bash
> hdc shell hidumper -ls
```
2.
查看系统服务列表中是否包含ThermalService系统服务。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录