回复
HarmonyOS API：@ohos.runningLock (Runninglock锁)
joytrian
发布于 2023-4-10 17:49
浏览
0收藏
版本：v3.1 Beta
@ohos.runningLock (Runninglock锁)
更新时间: 2023-02-17 09:19
该模块主要提供RunningLock锁相关操作的接口，包括创建、查询、持锁、释放锁等操作。
说明
本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
导入模块
import runningLock from '@ohos.runningLock';
runningLock.isSupported9+
isSupported(type: RunningLockType): boolean;
查询系统是否支持该类型的锁。
系统能力： SystemCapability.PowerManager.PowerManager.Core
参数：
参数名 | 类型 | 必填 | 说明 |
type | 是 | 需要查询的锁的类型。 |
返回值：
类型 | 说明 |
boolean | 返回true表示支持，返回false表示不支持。 |
错误码：
以下错误码的详细介绍请参见RunningLock锁错误码。
错误码ID | 错误信息 |
4900101 | 连接服务失败。 |
示例：
try {
var isSupported = runningLock.isSupported(runningLock.RunningLockType.BACKGROUND);
console.info('BACKGROUND type supported: ' + isSupported);
} catch(err) {
console.error('check supported failed, err: ' + err);
}
runningLock.create9+
create(name: string, type: RunningLockType, callback: AsyncCallback<RunningLock>): void
创建RunningLock锁。
系统能力： SystemCapability.PowerManager.PowerManager.Core
需要权限： ohos.permission.RUNNING_LOCK
参数：
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 锁的名字。 |
type | 是 | 要创建的锁的类型。 | |
callback | AsyncCallback<RunningLock> | 是 | 回调函数。当创建锁成功，err为undefined，data为创建的RunningLock；否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见RunningLock锁错误码。
错误码ID | 错误信息 |
4900101 | 连接服务器失败。 |
示例：
runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err, lock) => {
if (typeof err === 'undefined') {
console.info('created running lock: ' + lock);
} else {
console.error('create running lock failed, err: ' + err);
}
});
runningLock.create9+
create(name: string, type: RunningLockType): Promise<RunningLock>
创建RunningLock锁。
系统能力： SystemCapability.PowerManager.PowerManager.Core
需要权限： ohos.permission.RUNNING_LOCK
参数：
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 锁的名字。 |
type | 是 | 要创建的锁的类型。 |
返回值：
类型 | 说明 |
Promise<RunningLock> | Promise对象，返回RunningLock锁对象。 |
错误码：
以下错误码的详细介绍请参见RunningLock锁错误码。
错误码ID | 错误信息 |
4900101 | 连接服务器失败。 |
示例：
runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
console.info('created running lock: ' + lock);
})
.catch(err => {
console.error('create running lock failed, error: ' + err);
});
runningLock.isRunningLockTypeSupported(deprecated)
isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback<boolean>): void
说明
从API version 9开始不再维护，建议使用runningLock.isSupported替代。
查询系统是否支持该类型的锁。使用callback异步回调。
系统能力： SystemCapability.PowerManager.PowerManager.Core
参数：
参数名 | 类型 | 必填 | 说明 |
type | 是 | 需要查询的锁的类型。 | |
callback | AsyncCallback<boolean> | 是 | 回调函数。当查询成功，err为undefined，data为获取到的支持情况，返回true表示支持，返回false表示不支持；否则为错误对象。 |
示例：
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);
}
});
runningLock.isRunningLockTypeSupported(deprecated)
isRunningLockTypeSupported(type: RunningLockType): Promise<boolean>
说明
从API version 9开始不再维护，建议使用runningLock.isSupported替代。
查询系统是否支持该类型的锁。使用Promise异步回调。
系统能力： SystemCapability.PowerManager.PowerManager.Core
参数：
参数名 | 类型 | 必填 | 说明 |
type | 是 | 需要查询的锁的类型。 |
返回值：
类型 | 说明 |
Promise<boolean> | Promise对象。返回true表示支持；返回false表示不支持。 |
示例：
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(deprecated)
createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback<RunningLock>): void
说明
从API version 9开始不再维护，建议使用runningLock.create替代。
创建RunningLock锁。
系统能力： SystemCapability.PowerManager.PowerManager.Core
需要权限： ohos.permission.RUNNING_LOCK
参数：
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 锁的名字。 |
type | 是 | 要创建的锁的类型。 | |
callback | AsyncCallback<RunningLock> | 是 | 回调函数。当创建锁成功，err为undefined，data为创建的RunningLock；否则为错误对象。 |
示例：
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err, lock) => {
if (typeof err === 'undefined') {
console.info('created running lock: ' + lock);
} else {
console.error('create running lock failed, err: ' + err);
}
});
runningLock.createRunningLock(deprecated)
createRunningLock(name: string, type: RunningLockType): Promise<RunningLock>
说明
从API version 9开始不再维护，建议使用runningLock.create替代。
创建RunningLock锁。
系统能力： SystemCapability.PowerManager.PowerManager.Core
需要权限： ohos.permission.RUNNING_LOCK
参数：
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 锁的名字。 |
type | 是 | 要创建的锁的类型。 |
返回值：
类型 | 说明 |
Promise<RunningLock> | Promise对象，返回RunningLock锁对象。 |
示例：
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
console.info('created running lock: ' + lock);
})
.catch(err => {
console.log('create running lock failed, err: ' + err);
});
RunningLock
阻止系统休眠的锁。
hold9+
hold(timeout: number): void
锁定和持有RunningLock。
系统能力： SystemCapability.PowerManager.PowerManager.Core
需要权限： ohos.permission.RUNNING_LOCK
参数：
参数名 | 类型 | 必填 | 说明 |
timeout | number | 是 | 锁定和持有RunningLock的时长，单位：毫秒。 |
错误码：
以下错误码的详细介绍请参见RunningLock锁错误码。
错误码ID | 错误信息 |
4900101 | 连接服务器失败。 |
示例：
runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
console.info('create running lock success');
try {
lock.hold(500);
console.info('hold running lock success');
} catch(err) {
console.error('hold running lock failed, err: ' + err);
}
})
.catch(err => {
console.error('create running lock failed, err: ' + err);
});
unhold9+
unhold(): void
释放RunningLock锁。
系统能力： SystemCapability.PowerManager.PowerManager.Core
需要权限： ohos.permission.RUNNING_LOCK
错误码：
以下错误码的详细介绍请参见RunningLock锁错误码。
错误码ID | 错误信息 |
4900101 | 连接服务器失败。 |
示例：
runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
console.info('create running lock success');
try {
lock.unhold();
console.info('unhold running lock success');
} catch(err) {
console.error('unhold running lock failed, err: ' + err);
}
})
.catch(err => {
console.error('create running lock failed, err: ' + err);
});
isHolding9+
isHolding(): boolean
查询当前RunningLock是持有状态还是释放状态。
系统能力： SystemCapability.PowerManager.PowerManager.Core
返回值：
类型 | 说明 |
boolean | 返回true表示当前RunningLock是持有状态，返回false表示当前RunningLock是释放状态。 |
错误码：
以下错误码的详细介绍请参见RunningLock锁错误码。
错误码ID | 错误信息 |
4900101 | 连接服务失败。 |
示例：
runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
console.info('create running lock success');
try {
var isHolding = lock.isHolding();
console.info('check running lock holding status: ' + isHolding);
} catch(err) {
console.error('check running lock holding status failed, err: ' + err);
}
})
.catch(err => {
console.error('create running lock failed, err: ' + err);
});
lock(deprecated)
lock(timeout: number): void
从API version 9开始不再维护，建议使用RunningLock.hold替代。
锁定和持有RunningLock。
系统能力： SystemCapability.PowerManager.PowerManager.Core
需要权限： ohos.permission.RUNNING_LOCK
参数：
参数名 | 类型 | 必填 | 说明 |
timeout | number | 是 | 锁定和持有RunningLock的时长，单位：毫秒。 |
示例：
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);
});
unlock(deprecated)
unlock(): void
从API version 9开始不再维护，建议使用RunningLock.unhold替代。
释放RunningLock锁。
系统能力： SystemCapability.PowerManager.PowerManager.Core
需要权限： ohos.permission.RUNNING_LOCK
示例：
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(deprecated)
isUsed(): boolean
从API version 9开始不再维护，建议使用RunningLock.isHolding替代。
查询当前RunningLock是持有状态还是释放状态。
系统能力： SystemCapability.PowerManager.PowerManager.Core
返回值：
类型 | 说明 |
boolean | 返回true表示当前RunningLock是持有状态，返回false表示当前RunningLock是释放状态。 |
示例：
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then(lock => {
var isUsed = lock.isUsed();
console.info('check running lock used status: ' + isUsed);
})
.catch(err => {
console.error('check running lock used status failed, err: ' + err);
});
RunningLockType
RunningLock锁的类型。
系统能力： SystemCapability.PowerManager.PowerManager.Core
名称 | 值 | 说明 |
BACKGROUND | 1 | 阻止系统休眠的锁。 |
PROXIMITY_SCREEN_CONTROL | 2 | 通过接近或者远离状态来控制亮灭屏的锁。 |
已于2023-4-10 17:49:22修改
赞
收藏
回复
相关推荐
