文档中心

导入模块

收起
自动换行
深色代码主题
复制
import {runningLock} from '@kit.BasicServicesKit';

runningLock.isSupported⁹⁺

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

isSupported(type: RunningLockType): boolean

查询系统是否支持该类型的锁。

系统能力： SystemCapability.PowerManager.PowerManager.Core

参数：

展开

参数名	类型	必填	说明
type	RunningLockType	是	需要查询的锁的类型；该参数必须是一个枚举类。

返回值：

展开

类型	说明
boolean	返回true表示支持，返回false表示不支持。

错误码：

以下错误码的详细介绍请参见通用错误码。

展开

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed.

示例：

收起
自动换行
深色代码主题
复制
try {
    let isSupported = runningLock.isSupported(runningLock.RunningLockType.PROXIMITY_SCREEN_CONTROL);
    console.info('BACKGROUND type supported: ' + isSupported);
} catch(err) {
    console.error('check supported failed, err: ' + err);
}

runningLock.create⁹⁺

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

create(name: string, type: RunningLockType, callback: AsyncCallback<RunningLock>): void

创建RunningLock锁。使用callback异步回调。

系统能力： SystemCapability.PowerManager.PowerManager.Core

需要权限： ohos.permission.RUNNING_LOCK

参数：

展开

参数名	类型	必填	说明
name	string	是	锁的名字；该参数必须为字符串类型。
type	RunningLockType	是	要创建的锁的类型；该参数必须是一个枚举类。
callback	AsyncCallback<RunningLock>	是	回调函数。当创建锁成功，err为undefined，data为创建的RunningLock；否则为错误对象；AsyncCallback封装了一个RunningLock类型的类。

错误码：

以下错误码的详细介绍请参见通用错误码。

展开

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Parameter verification failed.
201	If the permission is denied.

示例：

收起
自动换行
深色代码主题
复制
runningLock.create('running_lock_test', runningLock.RunningLockType.PROXIMITY_SCREEN_CONTROL, (err: Error, lock: runningLock.RunningLock) => {
    if (typeof err === 'undefined') {
        console.info('created running lock: ' + lock);
    } else {
        console.error('create running lock failed, err: ' + err);
    }
});

runningLock.create⁹⁺

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

create(name: string, type: RunningLockType): Promise<RunningLock>

创建RunningLock锁。使用Promise异步回调。

系统能力： SystemCapability.PowerManager.PowerManager.Core

需要权限： ohos.permission.RUNNING_LOCK

参数：

展开

参数名	类型	必填	说明
name	string	是	锁的名字；该参数必须为字符串类型。
type	RunningLockType	是	要创建的锁的类型；该参数必须是一个枚举类。

返回值：

展开

类型	说明
Promise<RunningLock>	Promise对象，返回RunningLock锁对象。

错误码：

以下错误码的详细介绍请参见通用错误码。

展开

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Parameter verification failed.
201	If the permission is denied.

示例：

收起
自动换行
深色代码主题
复制
runningLock.create('running_lock_test', runningLock.RunningLockType.PROXIMITY_SCREEN_CONTROL)
.then((lock: runningLock.RunningLock) => {
    console.info('created running lock: ' + lock);
})
.catch((err: Error) => {
    console.error('create running lock failed, err: ' + err);
});

runningLock.isRunningLockTypeSupported^(deprecated)

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

isRunningLockTypeSupported(type: RunningLockType, callback: AsyncCallback<boolean>): void

查询系统是否支持该类型的锁。使用callback异步回调。

说明

从API version 7开始支持，从API version 9开始不再维护，建议使用runningLock.isSupported替代。

系统能力： SystemCapability.PowerManager.PowerManager.Core

参数：

展开

参数名	类型	必填	说明
type	RunningLockType	是	需要查询的锁的类型。
callback	AsyncCallback<boolean>	是	回调函数。当查询成功，err为undefined，data为获取到的支持情况，返回true表示支持，返回false表示不支持；否则为错误对象。

示例：

收起
自动换行
深色代码主题
复制
runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND, (err: Error, data: boolean) => {
    if (typeof err === 'undefined') {
        console.info('BACKGROUND lock support status: ' + data);
    } else {
        console.error('check BACKGROUND lock support status failed, err: ' + err);
    }
});

runningLock.isRunningLockTypeSupported^(deprecated)

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

isRunningLockTypeSupported(type: RunningLockType): Promise<boolean>

查询系统是否支持该类型的锁。使用Promise异步回调。

说明

从API version 7开始支持，从API version 9开始不再维护，建议使用runningLock.isSupported替代。

系统能力： SystemCapability.PowerManager.PowerManager.Core

参数：

展开

参数名	类型	必填	说明
type	RunningLockType	是	需要查询的锁的类型。

返回值：

展开

类型	说明
Promise<boolean>	Promise对象。返回true表示支持；返回false表示不支持。

示例：

收起
自动换行
深色代码主题
复制
runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND)
.then((data: boolean) => {
    console.info('BACKGROUND lock support status: ' + data);
})
.catch((err: Error) => {
    console.error('check BACKGROUND lock support status failed, err: ' + err);
});

runningLock.createRunningLock^(deprecated)

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback<RunningLock>): void

创建RunningLock锁。使用callback异步回调。

说明

从API version 7开始支持，从API version 9开始不再维护，建议使用runningLock.create替代。

系统能力： SystemCapability.PowerManager.PowerManager.Core

需要权限： ohos.permission.RUNNING_LOCK

参数：

展开

参数名	类型	必填	说明
name	string	是	锁的名字。建议使用包名或类名加后缀的方式命名。
type	RunningLockType	是	要创建的锁的类型。
callback	AsyncCallback<RunningLock>	是	回调函数。当创建锁成功，err为undefined，data为创建的RunningLock；否则为错误对象。AsyncCallback封装了一个RunningLock类型的类。

示例：

收起
自动换行
深色代码主题
复制
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND, (err: Error, lock: runningLock.RunningLock) => {
    if (typeof err === 'undefined') {
        console.info('created running lock: ' + lock);
    } else {
        console.error('create running lock failed, err: ' + err);
    }
});

runningLock.createRunningLock^(deprecated)

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

createRunningLock(name: string, type: RunningLockType): Promise<RunningLock>

创建RunningLock锁。使用Promise异步回调。

说明

从API version 7开始支持，从API version 9开始不再维护，建议使用runningLock.create替代。

系统能力： SystemCapability.PowerManager.PowerManager.Core

需要权限： ohos.permission.RUNNING_LOCK

参数：

展开

参数名	类型	必填	说明
name	string	是	锁的名字。建议使用包名或类名加后缀的方式命名。
type	RunningLockType	是	要创建的锁的类型。

返回值：

展开

类型	说明
Promise<RunningLock>	Promise对象，返回RunningLock锁对象。

示例：

收起
自动换行
深色代码主题
复制
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then((lock: runningLock.RunningLock) => {
    console.info('created running lock: ' + lock);
})
.catch((err: Error) => {
    console.error('create running lock failed, err: ' + err);
});

RunningLock

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

阻止系统睡眠的锁。

hold⁹⁺

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

hold(timeout: number): void

锁定和持有RunningLock。

系统能力： SystemCapability.PowerManager.PowerManager.Core

需要权限： ohos.permission.RUNNING_LOCK

参数：

展开

参数名	类型	必填	说明
timeout	number	是	锁定和持有RunningLock的时长，单位：毫秒。该参数必须为数字类型： -1：永久持锁，需要主动释放。 0：默认3s后超时释放。 >0：按传入值超时释放。

参数名

类型

必填

说明

timeout

number

是

锁定和持有RunningLock的时长，单位：毫秒。

该参数必须为数字类型：

-1：永久持锁，需要主动释放。

0：默认3s后超时释放。

>0：按传入值超时释放。

错误码：

以下错误码的详细介绍请参见通用错误码。

展开

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Incorrect parameter types.
201	If the permission is denied.

示例：

收起
自动换行
深色代码主题
复制
// RunningLockTest.ets
class RunningLockTest {
    public static recordLock: runningLock.RunningLock;

    public static holdRunningLock(): void {
        if (RunningLockTest.recordLock) {
            RunningLockTest.recordLock.hold(500);
            console.info('hold running lock success');
        } else {
            runningLock.create('running_lock_test', runningLock.RunningLockType.PROXIMITY_SCREEN_CONTROL, (err: Error, lock: runningLock.RunningLock) => {
                if (typeof err === 'undefined') {
                    console.info('create running lock: ' + lock);
                    RunningLockTest.recordLock = lock;
                    try {
                        lock.hold(500);
                        console.info('hold running lock success');
                    } catch(err) {
                        console.error('hold running lock failed, err: ' + err);
                    }
                } else {
                    console.error('create running lock failed, err: ' + err);
                }
            });
        }
    }
}

unhold⁹⁺

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

unhold(): void

释放RunningLock锁。

系统能力： SystemCapability.PowerManager.PowerManager.Core

需要权限： ohos.permission.RUNNING_LOCK

错误码：

以下错误码的详细介绍请参见通用错误码。

展开

错误码ID	错误信息
201	If the permission is denied.

示例：

收起
自动换行
深色代码主题
复制
// RunningLockTest.ets
class RunningLockTest {
    public static recordLock: runningLock.RunningLock;

    public static unholdRunningLock(): void {
        if (RunningLockTest.recordLock) {
            RunningLockTest.recordLock.unhold();
            console.info('unhold running lock success');
        } else {
            runningLock.create('running_lock_test', runningLock.RunningLockType.PROXIMITY_SCREEN_CONTROL, (err: Error, lock: runningLock.RunningLock) => {
                if (typeof err === 'undefined') {
                    console.info('create running lock: ' + lock);
                    RunningLockTest.recordLock = lock;
                    try {
                        lock.unhold();
                        console.info('unhold running lock success');
                    } catch(err) {
                        console.error('unhold running lock failed, err: ' + err);
                    }
                } else {
                    console.error('create running lock failed, err: ' + err);
                }
            });
        }
    }
}

isHolding⁹⁺

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

isHolding(): boolean

查询当前RunningLock是持有状态还是释放状态。

系统能力： SystemCapability.PowerManager.PowerManager.Core

返回值：

展开

类型	说明
boolean	返回true表示当前RunningLock是持有状态，返回false表示当前RunningLock是释放状态。

示例：

收起
自动换行
深色代码主题
复制
// RunningLockTest.ets
class RunningLockTest {
    public static recordLock: runningLock.RunningLock;

    public static isHoldingRunningLock(): void {
        if (RunningLockTest.recordLock) {
            let isHolding = RunningLockTest.recordLock.isHolding();
            console.info('check running lock holding status: ' + isHolding);
        } else {
            runningLock.create('running_lock_test', runningLock.RunningLockType.PROXIMITY_SCREEN_CONTROL, (err: Error, lock: runningLock.RunningLock) => {
                if (typeof err === 'undefined') {
                    console.info('create running lock: ' + lock);
                    RunningLockTest.recordLock = lock;
                    let isHolding = lock.isHolding();
                    console.info('check running lock holding status: ' + isHolding);
                } else {
                    console.error('create running lock failed, err: ' + err);
                }
            });
        }
    }
}

lock^(deprecated)

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

lock(timeout: number): void

锁定和持有RunningLock。

说明

从API version 7开始支持，从API version 9开始不再维护，建议使用RunningLock.hold替代。

系统能力： SystemCapability.PowerManager.PowerManager.Core

需要权限： ohos.permission.RUNNING_LOCK

参数：

展开

参数名	类型	必填	说明
timeout	number	是	锁定和持有RunningLock的时长，单位：毫秒。

示例：

收起
自动换行
深色代码主题
复制
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then((lock: runningLock.RunningLock) => {
    lock.lock(500);
    console.info('create running lock and lock success');
})
.catch((err: Error) => {
    console.error('create running lock failed, err: ' + err);
});

unlock^(deprecated)

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

unlock(): void

释放RunningLock锁。

说明

从API version 7开始支持，从API version 9开始不再维护，建议使用RunningLock.unhold替代。

系统能力： SystemCapability.PowerManager.PowerManager.Core

需要权限： ohos.permission.RUNNING_LOCK

示例：

收起
自动换行
深色代码主题
复制
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then((lock: runningLock.RunningLock) => {
    lock.unlock();
    console.info('create running lock and unlock success');
})
.catch((err: Error) => {
    console.error('create running lock failed, err: ' + err);
});

isUsed^(deprecated)

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

isUsed(): boolean

查询当前RunningLock是持有状态还是释放状态。

说明

从API version 7开始支持，从API version 9开始不再维护，建议使用RunningLock.isHolding替代。

系统能力： SystemCapability.PowerManager.PowerManager.Core

返回值：

展开

类型	说明
boolean	返回true表示当前RunningLock是持有状态，返回false表示当前RunningLock是释放状态。

示例：

收起
自动换行
深色代码主题
复制
runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then((lock: runningLock.RunningLock) => {
    let isUsed = lock.isUsed();
    console.info('check running lock used status: ' + isUsed);
})
.catch((err: Error) => {
    console.error('check running lock used status failed, err: ' + err);
});

RunningLockType

Phone12+PC/2in113+Tablet12+TV23+Wearable18+

RunningLock锁的类型。

系统能力： SystemCapability.PowerManager.PowerManager.Core

展开

名称	值	说明
BACKGROUND^(deprecated)	1	阻止系统睡眠的锁。说明：从API version 7开始支持，从API version 10开始废弃。
PROXIMITY_SCREEN_CONTROL	2	接近光锁，使能接近光传感器，并根据传感器与障碍物的距离远近发起亮灭屏流程。
BACKGROUND_USER_IDLE²³⁺	129	阻止系统自动睡眠的后台闲时任务锁，持锁能保证一段时间用户不活动后系统不进入自动睡眠。注意：不能阻止如PC合盖等场景系统进入强制睡眠，使用方必须监听COMMON_EVENT_ENTER_FORCE_SLEEP，监听到事件后释放该锁。该类型锁行为存在设备差异，使用该类型锁请参考阻止系统闲时进入睡眠开发指南。

名称

值

说明

BACKGROUND^(deprecated)

1

阻止系统睡眠的锁。

说明： 从API version 7开始支持，从API version 10开始废弃。

PROXIMITY_SCREEN_CONTROL

2

接近光锁，使能接近光传感器，并根据传感器与障碍物的距离远近发起亮灭屏流程。

BACKGROUND_USER_IDLE²³⁺

129

阻止系统自动睡眠的后台闲时任务锁，持锁能保证一段时间用户不活动后系统不进入自动睡眠。

注意： 不能阻止如PC合盖等场景系统进入强制睡眠，使用方必须监听COMMON_EVENT_ENTER_FORCE_SLEEP，监听到事件后释放该锁。该类型锁行为存在设备差异，使用该类型锁请参考阻止系统闲时进入睡眠开发指南。

@ohos.runningLock (RunningLock锁)

导入模块

runningLock.isSupported9+

runningLock.create9+

runningLock.create9+

runningLock.isRunningLockTypeSupported(deprecated)

runningLock.isRunningLockTypeSupported(deprecated)

runningLock.createRunningLock(deprecated)

runningLock.createRunningLock(deprecated)

RunningLock

hold9+

unhold9+

isHolding9+

lock(deprecated)

unlock(deprecated)

isUsed(deprecated)

RunningLockType

runningLock.isSupported⁹⁺

runningLock.create⁹⁺

runningLock.create⁹⁺

runningLock.isRunningLockTypeSupported^(deprecated)

runningLock.isRunningLockTypeSupported^(deprecated)

runningLock.createRunningLock^(deprecated)

runningLock.createRunningLock^(deprecated)

hold⁹⁺

unhold⁹⁺

isHolding⁹⁺

lock^(deprecated)

unlock^(deprecated)

isUsed^(deprecated)