提交 bf8d5545 编写于 作者: A aqxyjay

modify as review

Signed-off-by: Naqxyjay <zhangchunxin@huawei.com>
上级 7e3f846f
......@@ -16,7 +16,7 @@ import batteryStats from '@ohos.batteryStatistics';
## batteryStats.getBatteryStats
getBatteryStats(): Promise<Array<[BatteryStatsInfo](#batterystatsinfo)>>
getBatteryStats(): Promise<Array&lt;BatteryStatsInfo&gt;>
获取耗电信息列表。使用Promise异步回调。
......@@ -36,7 +36,6 @@ getBatteryStats(): Promise<Array<[BatteryStatsInfo](#batterystatsinfo)>>
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 4600101 | 连接服务失败。 |
**示例:**
......@@ -53,7 +52,7 @@ batteryStats.getBatteryStats()
## batteryStats.getBatteryStats
getBatteryStats(callback: AsyncCallback<Array<[BatteryStatsInfo](#batterystatsinfo)>>): void
getBatteryStats(callback: AsyncCallback<Array&lt;BatteryStatsInfo&gt;>): void
获取耗电信息列表。使用callback异步回调。
......@@ -73,8 +72,6 @@ getBatteryStats(callback: AsyncCallback<Array<[BatteryStatsInfo](#batterystatsin
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4600101 | 连接服务失败。 |
**示例:**
......@@ -117,8 +114,6 @@ getAppPowerValue(uid: number): number
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4600101 | 连接服务失败。 |
**示例:**
......@@ -160,8 +155,6 @@ getAppPowerPercent(uid: number): number
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4600101 | 连接服务失败。 |
**示例:**
......@@ -177,7 +170,7 @@ try {
## batteryStats.getHardwareUnitPowerValue
getHardwareUnitPowerValue(type: [ConsumptionType](#consumptiontype)): number
getHardwareUnitPowerValue(type: ConsumptionType): number
根据耗电类型获取硬件单元的耗电量。
......@@ -203,8 +196,6 @@ getHardwareUnitPowerValue(type: [ConsumptionType](#consumptiontype)): number
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4600101 | 连接服务失败。 |
**示例:**
......@@ -220,7 +211,7 @@ try {
## batteryStats.getHardwareUnitPowerPercent
getHardwareUnitPowerPercent(type: [ConsumptionType](#consumptiontype)): number
getHardwareUnitPowerPercent(type: ConsumptionType): number
根据耗电类型获取硬件单元的耗电百分比。
......@@ -246,8 +237,6 @@ getHardwareUnitPowerPercent(type: [ConsumptionType](#consumptiontype)): number
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4600101 | 连接服务失败。 |
**示例:**
......
......@@ -36,8 +36,6 @@ setValue(value: number): void
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4700101 | 连接服务失败。 |
**示例:**
......
......@@ -35,8 +35,6 @@ shutdown(reason: string): void
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 连接服务失败。 |
**示例:**
......@@ -49,30 +47,6 @@ try {
}
```
## power.rebootDevice<sup>(deprecated)</sup>
rebootDevice(reason: string): void
> 从API version 9开始不再维护,建议使用[power.reboot](#power.reboot9)替代。
重启设备。
**需要权限:** ohos.permission.REBOOT
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- |
| reason | string | 是 | 重启原因。 |
**示例:**
```js
power.rebootDevice('reboot_test');
```
## power.reboot<sup>9+</sup>
reboot(reason: string): void
......@@ -97,8 +71,6 @@ reboot(reason: string): void
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 连接服务失败。 |
**示例:**
......@@ -111,61 +83,6 @@ try {
}
```
## power.isScreenOn<sup>(deprecated)</sup>
isScreenOn(callback: AsyncCallback&lt;boolean&gt;): void
> 从API version 9开始不再维护,建议使用[power.isActive](#power.isactive9)替代。
检测当前设备的亮灭屏状态。使用callback异步回调。
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当检测成功,err为undefined,data为获取到的亮灭屏状态,返回true表示梁平,返回false表示灭屏;否则为错误对象。 |
**示例:**
```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&lt;boolean&gt;
> 从API version 9开始不再维护,建议使用[power.isActive](#power.isactive9)替代。
检测当前设备的亮灭屏状态。使用Promise异步回调。
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**返回值:**
| 类型 | 说明 |
| ---------------------- | -------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示亮屏;返回false表示灭屏。 |
**示例:**
```js
power.isScreenOn()
.then(data => {
console.info('screen on status is ' + data);
})
.catch(err => {
console.error('check screen status failed, err: ' + err);
})
```
## power.isActive<sup>9+</sup>
isActive(): boolean
......@@ -187,6 +104,7 @@ isActive(): boolean
```js
try {
var isActive = power.isActive();
console.info('power is active: ' + isActive);
} catch(err) {
console.error('check active status failed, err: ' + err);
}
......@@ -214,8 +132,6 @@ wakeup(detail: string): void
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 连接服务失败。 |
**示例:**
......@@ -244,22 +160,21 @@ suspend(): void
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 4900101 | 连接服务失败。 |
**示例:**
```js
try {
power.wakeup('wakeup_test');
power.suspend();
} catch(err) {
console.error('wakeup failed, err: ' + err);
console.error('suspend failed, err: ' + err);
}
```
## power.getPowerMode<sup>9+</sup>
getPowerMode(): [DevicePowerMode](#devicepowermode9)
getPowerMode(): DevicePowerMode
获取当前设备的电源模式。
......@@ -279,7 +194,6 @@ getPowerMode(): [DevicePowerMode](#devicepowermode9)
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 4900101 | 连接服务失败。 |
**示例:**
......@@ -287,6 +201,7 @@ getPowerMode(): [DevicePowerMode](#devicepowermode9)
```js
try {
var mode = power.getPowerMode();
console.info('power mode: ' + mode);
} catch(err) {
console.error('get power mode failed, err: ' + err);
}
......@@ -294,7 +209,7 @@ try {
## power.setPowerMode<sup>9+</sup>
setPowerMode(mode: [DevicePowerMode](#devicepowermode9), callback: AsyncCallback&lt;void&gt;): void
setPowerMode(mode: DevicePowerMode, callback: AsyncCallback&lt;void&gt;): void
设置当前设备的电源模式。使用callback异步回调。
......@@ -317,24 +232,18 @@ setPowerMode(mode: [DevicePowerMode](#devicepowermode9), callback: AsyncCallback
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 连接服务失败。 |
**示例:**
```js
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.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);
}
});
```
## power.setPowerMode<sup>9+</sup>
......@@ -367,24 +276,97 @@ setPowerMode(mode: DevicePowerMode): Promise&lt;void&gt;
| 错误码ID | 错误信息 |
|---------|---------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 链接服务失败。 |
**示例:**
```js
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) {
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.rebootDevice<sup>(deprecated)</sup>
rebootDevice(reason: string): void
> 从API version 9开始不再维护,建议使用[power.reboot](#powerreboot9)替代。
重启设备。
**需要权限:** ohos.permission.REBOOT
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- |
| reason | string | 是 | 重启原因。 |
**示例:**
```js
power.rebootDevice('reboot_test');
```
## power.isScreenOn<sup>(deprecated)</sup>
isScreenOn(callback: AsyncCallback&lt;boolean&gt;): void
> 从API version 9开始不再维护,建议使用[power.isActive](#powerisactive9)替代。
检测当前设备的亮灭屏状态。使用callback异步回调。
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当检测成功,err为undefined,data为获取到的亮灭屏状态,返回true表示梁平,返回false表示灭屏;否则为错误对象。 |
**示例:**
```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&lt;boolean&gt;
> 从API version 9开始不再维护,建议使用[power.isActive](#powerisactive9)替代。
检测当前设备的亮灭屏状态。使用Promise异步回调。
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**返回值:**
| 类型 | 说明 |
| ---------------------- | -------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示亮屏;返回false表示灭屏。 |
**示例:**
```js
power.isScreenOn()
.then(data => {
console.info('screen on status is ' + data);
})
.catch(err => {
console.error('check screen status failed, err: ' + err);
})
```
## DevicePowerMode<sup>9+</sup>
......
......@@ -11,72 +11,9 @@
import runningLock from '@ohos.runningLock';
```
## runningLock.isRunningLockTypeSupported<sup>(deprecated)</sup>
isRunningLockTypeSupported(type: [RunningLockType](#runninglocktype), callback: AsyncCallback&lt;boolean&gt;): void
> 从API version 9开始不再维护,建议使用[runningLock.isSupported](#runninglockissupported9)替代。
查询系统是否支持该类型的锁。使用callback异步回调。
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| type | [RunningLockType](#runninglocktype) | 是 | 需要查询的锁的类型。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当查询成功,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<sup>(deprecated)</sup>
isRunningLockTypeSupported(type: [RunningLockType](#runninglocktype)): Promise&lt;boolean>
> 从API version 9开始不再维护,建议使用[runningLock.isSupported](#runninglockissupported9)替代。
查询系统是否支持该类型的锁。使用Promise异步回调。
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | ---- | -------------------- |
| type | [RunningLockType](#runninglocktype) | 是 | 需要查询的锁的类型。 |
**返回值:**
| 类型 | 说明 |
| ---------------------- | ---------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示支持;返回false表示不支持。 |
## runningLock.isSupported<sup>9+</sup>
**示例:**
```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.isSupported<sup>9+</sup>
isSupported(type: [RunningLockType](#runninglocktype)): boolean;
isSupported(type: RunningLockType): boolean;
查询系统是否支持该类型的锁。
......@@ -100,7 +37,6 @@ isSupported(type: [RunningLockType](#runninglocktype)): boolean;
| 错误码ID | 错误信息 |
|---------|---------|
| 401 | 参数检查失败。 |
| 4900101 | 连接服务失败。 |
**示例:**
......@@ -108,16 +44,15 @@ isSupported(type: [RunningLockType](#runninglocktype)): boolean;
```js
try {
var isSupported = runningLock.isSupported(runningLock.RunningLockType.BACKGROUND);
console.info('BACKGROUND type supported: ' + isSupported);
} catch(err) {
console.error('check supported failed, err: ' + err);
}
```
## runningLock.createRunningLock<sup>(deprecated)</sup>
## runningLock.create<sup>9+</sup>
createRunningLock(name: string, type: [RunningLockType](#runninglocktype), callback: AsyncCallback&lt;[RunningLock](#runninglock)&gt;): void
> 从API version 9开始不再维护,建议使用[runningLock.create](#runninglockcreate9)替代。
createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback&lt;RunningLock&gt;): void
创建RunningLock锁。
......@@ -133,10 +68,18 @@ createRunningLock(name: string, type: [RunningLockType](#runninglocktype), callb
| type | [RunningLockType](#runninglocktype) | 是 | 要创建的锁的类型。 |
| callback | AsyncCallback<[RunningLock](#runninglock)> | 是 | 回调函数。当创建锁成功,err为undefined,data为创建的RunningLock;否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)
| 错误码ID | 错误信息 |
|---------|----------|
| 4900101 | 连接服务器失败。 |
**示例:**
```js
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err, lock) => {
runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err, lock) => {
if (typeof err === 'undefined') {
console.info('created running lock: ' + lock);
} else {
......@@ -145,11 +88,9 @@ runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.B
});
```
## runingLock.createRunningLock<sup>(deprecated)</sup>
## runningLock.create<sup>9+</sup>
createRunningLock(name: string, type: [RunningLockType](#runninglocktype)): Promise<[RunningLock](#runninglock)>
> 从API version 9开始不再维护,建议使用[runningLock.create](#runninglockcreate9)替代。
createRunningLock(name: string, type: RunningLockType): Promise&lt;RunningLock&gt;
创建RunningLock锁。
......@@ -170,21 +111,94 @@ createRunningLock(name: string, type: [RunningLockType](#runninglocktype)): Prom
| ------------------------------------------ | ------------------------------------ |
| Promise&lt;[RunningLock](#runninglock)&gt; | Promise对象,返回RunningLock锁对象。 |
**错误码:**
以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)
| 错误码ID | 错误信息 |
|---------|----------|
| 4900101 | 连接服务器失败。 |
**示例:**
```js
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
console.info('created running lock: ' + lock);
})
.catch(err => {
console.log('create running lock failed, err: ' + err);
console.error('create running lock failed, error: ' + err);
});
```
## runningLock.isRunningLockTypeSupported<sup>(deprecated)</sup>
isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback&lt;boolean&gt;): void
> 从API version 9开始不再维护,建议使用[runningLock.isSupported](#runninglockissupported9)替代。
查询系统是否支持该类型的锁。使用callback异步回调。
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| type | [RunningLockType](#runninglocktype) | 是 | 需要查询的锁的类型。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当查询成功,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.create<sup>9+</sup>
## runningLock.isRunningLockTypeSupported<sup>(deprecated)</sup>
createRunningLock(name: string, type: [RunningLockType](#runninglocktype), callback: AsyncCallback&lt;RunningLock&gt;): void
isRunningLockTypeSupported(type: RunningLockType): Promise&lt;boolean>
> 从API version 9开始不再维护,建议使用[runningLock.isSupported](#runninglockissupported9)替代。
查询系统是否支持该类型的锁。使用Promise异步回调。
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | ---- | -------------------- |
| type | [RunningLockType](#runninglocktype) | 是 | 需要查询的锁的类型。 |
**返回值:**
| 类型 | 说明 |
| ---------------------- | ---------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示支持;返回false表示不支持。 |
**示例:**
```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);
});
```
## runningLock.createRunningLock<sup>(deprecated)</sup>
createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback&lt;RunningLock&gt;): void
> 从API version 9开始不再维护,建议使用[runningLock.create](#runninglockcreate9)替代。
创建RunningLock锁。
......@@ -200,20 +214,10 @@ createRunningLock(name: string, type: [RunningLockType](#runninglocktype), callb
| type | [RunningLockType](#runninglocktype) | 是 | 要创建的锁的类型。 |
| callback | AsyncCallback<[RunningLock](#runninglock)> | 是 | 回调函数。当创建锁成功,err为undefined,data为创建的RunningLock;否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)
| 错误码ID | 错误信息 |
|---------|----------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 连接服务器失败。 |
**示例:**
```js
runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err, lock) => {
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err, lock) => {
if (typeof err === 'undefined') {
console.info('created running lock: ' + lock);
} else {
......@@ -222,9 +226,11 @@ runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND,
});
```
## runingLock.create<sup>9+</sup>
## runningLock.createRunningLock<sup>(deprecated)</sup>
createRunningLock(name: string, type: RunningLockType): Promise&lt;RunningLock&gt;
createRunningLock(name: string, type: [RunningLockType](#runninglocktype)): Promise&lt;RunningLock&gt;
> 从API version 9开始不再维护,建议使用[runningLock.create](#runninglockcreate9)替代。
创建RunningLock锁。
......@@ -245,25 +251,15 @@ createRunningLock(name: string, type: [RunningLockType](#runninglocktype)): Prom
| ------------------------------------------ | ------------------------------------ |
| Promise&lt;[RunningLock](#runninglock)&gt; | Promise对象,返回RunningLock锁对象。 |
**错误码:**
以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)
| 错误码ID | 错误信息 |
|---------|----------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 连接服务器失败。 |
**示例:**
```js
runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
console.info('created running lock: ' + lock);
})
.catch(err => {
console.error('create running lock failed, error: ' + err);
console.log('create running lock failed, err: ' + err);
});
```
......@@ -271,37 +267,6 @@ runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
阻止系统休眠的锁。
### lock<sup>(deprecated)</sup>
lock(timeout: number): void
> 从API version 9开始不再维护,建议使用[RunningLock.hold](#hold9)替代。
锁定和持有RunningLock。
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**需要权限:** ohos.permission.RUNNING_LOCK
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------------------- |
| timeout | number | 否 | 锁定和持有RunningLock的时长,单位:毫秒。 |
**示例:**
```js
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
lock.lock(500);
console.info('create running lock and lock success');
})
.catch(err => {
console.error('create running lock failed, err: ' + err);
});
```
### hold<sup>9+</sup>
hold(timeout: number): void
......@@ -324,8 +289,6 @@ hold(timeout: number): void
| 错误码ID | 错误信息 |
|---------|----------|
| 201 | 权限校验失败。 |
| 401 | 参数检查失败。 |
| 4900101 | 连接服务器失败。 |
**示例:**
......@@ -346,11 +309,9 @@ runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
});
```
### unlock<sup>(deprecated)</sup>
unlock(): void
### unhold<sup>9+</sup>
> 从API version 9开始不再维护,建议使用[RunningLock.unhold](#unhold9)替代。
unhold(): void
释放RunningLock锁。
......@@ -358,37 +319,53 @@ unlock(): void
**需要权限:** ohos.permission.RUNNING_LOCK
**错误码:**
以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)
| 错误码ID | 错误信息 |
|---------|----------|
| 4900101 | 连接服务器失败。 |
**示例:**
```js
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
lock.unlock();
console.info('create running lock and unlock success');
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);
});
```
### unhold<sup>9+</sup>
### isHolding<sup>9+</sup>
unhold(): void
isHolding(): boolean
释放RunningLock锁
查询当前RunningLock是持有状态还是释放状态
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**需要权限:** ohos.permission.RUNNING_LOCK
**返回值:**
| 类型 | 说明 |
| ------- | ------------------------------------------------------------ |
| boolean | 返回true表示当前RunningLock是持有状态,返回false表示当前RunningLock是释放状态。 |
**错误码:**
以下错误码的详细介绍请参见[RunningLock锁错误码](../errorcodes/errorcode-runninglock.md)
| 错误码ID | 错误信息 |
|---------|----------|
| 201 | 权限校验失败。 |
| 4900101 | 连接服务器失败。 |
| 错误码ID | 错误信息 |
|---------|---------|
| 4900101 | 连接服务失败。 |
**示例:**
......@@ -397,10 +374,10 @@ 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');
var isHolding = lock.isHolding();
console.info('check running lock holding status: ' + isHolding);
} catch(err) {
console.error('unhold running lock failed, err: ' + err);
console.error('check running lock holding status failed, err: ' + err);
}
})
.catch(err => {
......@@ -408,71 +385,87 @@ runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
});
```
### isUsed<sup>(deprecated)</sup>
### lock<sup>(deprecated)</sup>
isUsed(): boolean
lock(timeout: number): void
> 从API version 9开始不再维护,建议使用[RunningLock.isHolding](#isholding9)替代。
> 从API version 9开始不再维护,建议使用[RunningLock.hold](#hold9)替代。
查询当前RunningLock是持有状态还是释放状态
锁定和持有RunningLock
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**返回值:**
| 类型 | 说明 |
| ------- | ------------------------------------------------------------ |
| boolean | 返回true表示当前RunningLock是持有状态,返回false表示当前RunningLock是释放状态。 |
**需要权限:** ohos.permission.RUNNING_LOCK
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------------------- |
| timeout | number | 否 | 锁定和持有RunningLock的时长,单位:毫秒。 |
**示例:**
```js
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
var isUsed = lock.isUsed();
console.info('check running lock used status: ' + isUsed);
lock.lock(500);
console.info('create running lock and lock success');
})
.catch(err => {
console.error('check running lock used status failed, err: ' + err);
console.error('create running lock failed, err: ' + err);
});
```
### isHolding<sup>9+</sup>
### unlock<sup>(deprecated)</sup>
isHolding(): boolean
unlock(): void
> 从API version 9开始不再维护,建议使用[RunningLock.unhold](#unhold9)替代。
释放RunningLock锁。
**系统能力:** SystemCapability.PowerManager.PowerManager.Core
**需要权限:** ohos.permission.RUNNING_LOCK
**示例:**
```js
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
lock.unlock();
console.info('create running lock and unlock success');
})
.catch(err => {
console.error('create running lock failed, err: ' + err);
});
```
### isUsed<sup>(deprecated)</sup>
isUsed(): boolean
> 从API version 9开始不再维护,建议使用[RunningLock.isHolding](#isholding9)替代。
查询当前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)
runningLock.createRunningLock('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);
}
var isUsed = lock.isUsed();
console.info('check running lock used status: ' + isUsed);
})
.catch(err => {
console.error('create running lock failed, err: ' + err);
console.error('check running lock used status failed, err: ' + err);
});
```
......
......@@ -3,8 +3,8 @@
该模块提供充电状态及剩余电量的查询功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 从API Version 6开始不再维护,建议使用[`@ohos.batteryInfo`](js-apis-battery-info.md)替代。
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -17,7 +17,7 @@ import battery from '@system.battery';
## battery.getStatus
getStatus(options?: [GetStatusOptions](#getstatusoptions)): void;
getStatus(options?: GetStatusOptions): void;
获取设备当前的充电状态及剩余电量。
......
......@@ -3,9 +3,8 @@
该模块提供屏幕亮度和模式的查询、调节接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 从API Version 7 开始不再维护,建议使用[`@ohos.brightness`](js-apis-brightness.md)替代。
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -18,7 +17,7 @@ import brightness from '@system.brightness';
## brightness.getValue
getValue(options?: [GetBrightnessOptions](#getbrightnessoptions)): void
getValue(options?: GetBrightnessOptions): void
获得设备当前的屏幕亮度值。
......@@ -46,7 +45,7 @@ getValue(options?: [GetBrightnessOptions](#getbrightnessoptions)): void
## brightness.setValue
etValue(options?: [SetBrightnessOptions](#setbrightnessoptions)): void
etValue(options?: SetBrightnessOptions): void
设置设备当前的屏幕亮度值。
......@@ -75,7 +74,7 @@ etValue(options?: [SetBrightnessOptions](#setbrightnessoptions)): void
## brightness.getMode
getMode(options?: [GetBrightnessModeOptions](#getbrightnessmodeoptions): void
getMode(options?: GetBrightnessModeOptions: void
获得当前屏幕亮度模式。
......@@ -103,7 +102,7 @@ getMode(options?: [GetBrightnessModeOptions](#getbrightnessmodeoptions): void
## brightness.setMode
setMode(options?: [SetBrightnessModeOptions](#setbrightnessmodeoptions)): void
setMode(options?: SetBrightnessModeOptions): void
设置设备当前的屏幕亮度模式。
......@@ -131,7 +130,7 @@ setMode(options?: [SetBrightnessModeOptions](#setbrightnessmodeoptions)): void
## brightness.setKeepScreenOn
setKeepScreenOn(options?: [SetKeepScreenOnOptions](#setkeepscreenonoptions)): void
setKeepScreenOn(options?: SetKeepScreenOnOptions): void
>从API version 7开始不再维护,建议使用[window.setKeepScreenOn](js-apis-window.md#setkeepscreenon)替代。
......
......@@ -11,30 +11,6 @@
import thermal from '@ohos.thermal';
```
## thermal.subscribeThermalLevel<sup>(deprecated)</sup>
subscribeThermalLevel(callback: AsyncCallback&lt;ThermalLevel&gt;): void
> 从API version 9开始不再维护,建议使用[thermal.registerThermalLevelCallback](#thermalregisterthermallevelcallback9)替代。
订阅热档位变化时的回调提醒。
**系统能力:** SystemCapability.PowerManager.ThermalManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;ThermalLevel&gt; | 是 | 回调函数。AsyncCallback只返回一个参数,为热档位信息,此时可能会产生告警,可通过`// @ts-ignore`进行抑制。 |
**示例:**
```js
thermal.subscribeThermalLevel((level) => {
console.info('thermal level is: ' + level);
});
```
## thermal.registerThermalLevelCallback<sup>9+</sup>
registerThermalLevelCallback(callback: Callback&lt;ThermalLevel&gt;): void
......@@ -55,7 +31,6 @@ registerThermalLevelCallback(callback: Callback&lt;ThermalLevel&gt;): void
| 错误码ID | 错误信息 |
|---------|---------|
| 401 | 参数检查失败。 |
| 4800101 | 连接服务失败。 |
**示例:**
......@@ -71,30 +46,6 @@ try {
}
```
## thermal.unsubscribeThermalLevel<sup>(deprecated)</sup>
unsubscribeThermalLevel(callback?: AsyncCallback\<void>): void
> 从API version 9开始不再维护,建议使用[thermal.unregisterThermalLevelCallback](#thermalunregisterthermallevelcallback9)替代。
取消订阅热档位变化时的回调提醒。
**系统能力:** SystemCapability.PowerManager.ThermalManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数,无返回值。不填该参数则取消所有回调。 |
**示例:**
```js
thermal.unsubscribeThermalLevel(() => {
console.info('unsubscribe thermal level success.');
});
```
## thermal.unregisterThermalLevelCallback<sup>9+</sup>
unregisterThermalLevelCallback(callback?: Callback\<void>): void
......@@ -115,7 +66,6 @@ unregisterThermalLevelCallback(callback?: Callback\<void>): void
| 错误码ID | 错误信息 |
|---------|---------|
| 401 | 参数检查失败。 |
| 4800101 | 连接服务失败。 |
**示例:**
......@@ -131,29 +81,6 @@ try {
}
```
## thermal.getThermalLevel<sup>(deprecated)</sup>
getThermalLevel(): ThermalLevel
> 从API version 9开始不再维护,建议使用[thermal.getLevel](#thermalgetlevel9)替代。
获取当前热档位信息。
**系统能力:** SystemCapability.PowerManager.ThermalManager
**返回值:**
| 类型 | 说明 |
| ------------ | ------ |
| ThermalLevel | 热档位信息。 |
**示例:**
```js
var level = thermal.getThermalLevel();
console.info('thermal level is: ' + level);
```
## thermal.getLevel<sup>9+</sup>
getLevel(): ThermalLevel
......@@ -187,6 +114,77 @@ try {
}
```
## thermal.subscribeThermalLevel<sup>(deprecated)</sup>
subscribeThermalLevel(callback: AsyncCallback&lt;ThermalLevel&gt;): void
> 从API version 9开始不再维护,建议使用[thermal.registerThermalLevelCallback](#thermalregisterthermallevelcallback9)替代。
订阅热档位变化时的回调提醒。
**系统能力:** SystemCapability.PowerManager.ThermalManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;ThermalLevel&gt; | 是 | 回调函数。AsyncCallback只返回一个参数,为热档位信息,此时可能会产生告警,可通过`// @ts-ignore`进行抑制。 |
**示例:**
```js
thermal.subscribeThermalLevel((level) => {
console.info('thermal level is: ' + level);
});
```
## thermal.unsubscribeThermalLevel<sup>(deprecated)</sup>
unsubscribeThermalLevel(callback?: AsyncCallback\<void>): void
> 从API version 9开始不再维护,建议使用[thermal.unregisterThermalLevelCallback](#thermalunregisterthermallevelcallback9)替代。
取消订阅热档位变化时的回调提醒。
**系统能力:** SystemCapability.PowerManager.ThermalManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数,无返回值。不填该参数则取消所有回调。 |
**示例:**
```js
thermal.unsubscribeThermalLevel(() => {
console.info('unsubscribe thermal level success.');
});
```
## thermal.getThermalLevel<sup>(deprecated)</sup>
getThermalLevel(): ThermalLevel
> 从API version 9开始不再维护,建议使用[thermal.getLevel](#thermalgetlevel9)替代。
获取当前热档位信息。
**系统能力:** SystemCapability.PowerManager.ThermalManager
**返回值:**
| 类型 | 说明 |
| ------------ | ------ |
| ThermalLevel | 热档位信息。 |
**示例:**
```js
var level = thermal.getThermalLevel();
console.info('thermal level is: ' + level);
```
## ThermalLevel
热档位信息。
......
# 耗电统计错误码
## 201 权限校验失败
### 错误信息
Permission denied. The operation is forbidden by permission: `{$permission}`.
### 错误描述
权限校验失败,接口调用要求`{$permission}`权限。
### 可能原因
调用者未申请`{$permission}`权限。
### 处理步骤
申请`{$permission}`权限,具体申请方式请参考[访问控制授权申请指导](../../security/accesstoken-guidelines.md)
## 401 参数检查失败
### 错误信息
Parameter error. The incoming parameter `{$parameter}` is invalid.
### 错误描述
参数检查失败,调用者传入的参数`{$parameter}`无效。
### 可能原因
1. 调用者传入的参数`{$parameter}`类型无效。
2. 调用者传入的参数`{$parameter}`值无效。
### 处理步骤
1. 检查传入的参数`{$parameter}`类型是否正确。
2. 检查传入的参数`{$parameter}`值是否正确。
## 4600101 连接服务失败
### 错误信息
**错误信息**
Operation failed. Cannot connect to service.
### 错误描述
**错误描述**
操作失败,连接系统服务发生异常。
### 可能原因
**可能原因**
1. 系统服务停止运行。
2. 系统服务内部通讯发生异常。
### 处理步骤
**处理步骤**
检查系统服务是否正常运行。
1. 在控制台中输入如下命令,查看当前的系统服务列表。
```bash
> hdc shell hidumper -ls
```
```bash
> hdc shell hidumper -ls
```
2. 查看系统服务列表中是否包含BatteryStatisticsService系统服务。
\ No newline at end of file
2. 查看系统服务列表中是否包含BatteryStatisticsService系统服务。
# 屏幕亮度错误码
## 201 权限校验失败
### 错误信息
Permission denied. The operation is forbidden by permission: `{$permission}`.
### 错误描述
权限校验失败,接口调用要求`{$permission}`权限。
### 可能原因
调用者未申请`{$permission}`权限。
### 处理步骤
申请`{$permission}`权限,具体申请方式请参考[访问控制授权申请指导](../../security/accesstoken-guidelines.md)
## 401 参数检查失败
### 错误信息
Parameter error. The incoming parameter `{$parameter}` is invalid.
### 错误描述
参数检查失败,调用者传入的参数`{$parameter}`无效。
### 可能原因
1. 调用者传入的参数`{$parameter}`类型无效。
2. 调用者传入的参数`{$parameter}`值无效。
### 处理步骤
1. 检查传入的参数`{$parameter}`类型是否正确。
2. 检查传入的参数`{$parameter}`值是否正确。
## 4700101 连接服务失败
### 错误信息
**错误信息**
Operation failed. Cannot connect to service.
### 错误描述
**错误描述**
操作失败,连接系统服务发生异常。
### 可能原因
**可能原因**
1. 系统服务停止运行。
2. 系统服务内部通讯发生异常。
### 处理步骤
**处理步骤**
检查系统服务是否正常运行。
1. 在控制台中输入如下命令,查看当前的系统服务列表。
```bash
> hdc shell hidumper -ls
```
```bash
> hdc shell hidumper -ls
```
2. 查看系统服务列表中是否包含DisplayPowerManagerService系统服务。
\ No newline at end of file
2. 查看系统服务列表中是否包含DisplayPowerManagerService系统服务。
# 系统电源管理错误码
## 201 权限校验失败
### 错误信息
Permission denied. The operation is forbidden by permission: `{$permission}`.
### 错误描述
权限校验失败,接口调用要求`{$permission}`权限。
### 可能原因
调用者未申请`{$permission}`权限。
### 处理步骤
申请`{$permission}`权限,具体申请方式请参考[访问控制授权申请指导](../../security/accesstoken-guidelines.md)
## 401 参数检查失败
### 错误信息
Parameter error. The incoming parameter `{$parameter}` is invalid.
### 错误描述
参数检查失败,调用者传入的参数`{$parameter}`无效。
### 可能原因
1. 调用者传入的参数`{$parameter}`类型无效。
2. 调用者传入的参数`{$parameter}`值无效。
### 处理步骤
1. 检查传入的参数`{$parameter}`类型是否正确。
2. 检查传入的参数`{$parameter}`值是否正确。
## 4900101 连接服务失败
### 错误信息
**错误信息**
Operation failed. Cannot connect to service.
### 错误描述
**错误描述**
操作失败,连接系统服务发生异常。
### 可能原因
**可能原因**
1. 系统服务停止运行。
2. 系统服务内部通讯发生异常。
### 处理步骤
**处理步骤**
检查系统服务是否正常运行。
1. 在控制台中输入如下命令,查看当前的系统服务列表。
```bash
> hdc shell hidumper -ls
```
2. 查看系统服务列表中是否包含xx系统服务。
```bash
> hdc shell hidumper -ls
```
PowerManagerService BatteryService
ThermalService BatteryStatisticsService DisplayPowerManagerService
2. 查看系统服务列表中是否包含PowerManagerService系统服务。
## 4900102 正在关机中
### 错误信息
**错误信息**
Operation failed. System is shutting down.
### 错误描述
**错误描述**
操作失败,系统正在关机。
### 可能原因
**可能原因**
系统正在处于关机过程中。
### 处理步骤
**处理步骤**
在系统正常运行的状态下进行操作。
\ No newline at end of file
在系统正常运行的状态下进行操作。
# RunningLock锁错误码
## 201 权限校验失败
### 错误信息
Permission denied. The operation is forbidden by permission: `{$permission}`.
### 错误描述
权限校验失败,接口调用要求`{$permission}`权限。
### 可能原因
调用者未申请`{$permission}`权限。
### 处理步骤
申请`{$permission}`权限,具体申请方式请参考[访问控制授权申请指导](../../security/accesstoken-guidelines.md)
## 401 参数检查失败
### 错误信息
Parameter error. The incoming parameter `{$parameter}` is invalid.
### 错误描述
参数检查失败,调用者传入的参数`{$parameter}`无效。
### 可能原因
1. 调用者传入的参数`{$parameter}`类型无效。
2. 调用者传入的参数`{$parameter}`值无效。
### 处理步骤
1. 检查传入的参数`{$parameter}`类型是否正确。
2. 检查传入的参数`{$parameter}`值是否正确。
## 4900101 连接服务失败
### 错误信息
**错误信息**
Operation failed. Cannot connect to service.
### 错误描述
**错误描述**
操作失败,连接系统服务发生异常。
### 可能原因
**可能原因**
1. 系统服务停止运行。
2. 系统服务内部通讯发生异常。
### 处理步骤
**处理步骤**
检查系统服务是否正常运行。
1. 在控制台中输入如下命令,查看当前的系统服务列表。
```bash
> hdc shell hidumper -ls
```
```bash
> hdc shell hidumper -ls
```
2. 查看系统服务列表中是否包含PowerManagerService系统服务。
\ No newline at end of file
2. 查看系统服务列表中是否包含PowerManagerService系统服务。
# 热管理错误码
## 401 参数检查失败
### 错误信息
Parameter error. The incoming parameter `{$parameter}` is invalid.
### 错误描述
参数检查失败,调用者传入的参数`{$parameter}`无效。
### 可能原因
1. 调用者传入的参数`{$parameter}`类型无效。
2. 调用者传入的参数`{$parameter}`值无效。
### 处理步骤
1. 检查传入的参数`{$parameter}`类型是否正确。
2. 检查传入的参数`{$parameter}`值是否正确。
## 4800101 连接服务失败
### 错误信息
**错误信息**
Operation failed. Cannot connect to service.
### 错误描述
**错误描述**
操作失败,连接系统服务发生异常。
### 可能原因
**可能原因**
1. 系统服务停止运行。
2. 系统服务内部通讯发生异常。
### 处理步骤
**处理步骤**
检查系统服务是否正常运行。
1. 在控制台中输入如下命令,查看当前的系统服务列表。
```bash
> hdc shell hidumper -ls
```
```bash
> hdc shell hidumper -ls
```
2. 查看系统服务列表中是否包含ThermalService系统服务。
\ No newline at end of file
2. 查看系统服务列表中是否包含ThermalService系统服务。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册