@ohos.runningLock (Running Lock)

The runningLock module provides APIs for creating, querying, holding, and releasing running locks.

NOTE

The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import runningLock from '@ohos.runningLock';

runningLock.isSupported⁹⁺

isSupported(type: RunningLockType): boolean;

Checks whether the specified type of RunningLock is supported.

System capability: SystemCapability.PowerManager.PowerManager.Core

Parameters

Return value

Error codes

For details about the error codes, see RunningLock Error Codes.

Example

try {
    let isSupported = runningLock.isSupported(runningLock.RunningLockType.BACKGROUND);
    console.info('BACKGROUND type supported: ' + isSupported);
} catch(err) {
    console.error('check supported failed, err: ' + err);
}

runningLock.create⁹⁺

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

Creates a RunningLock object.

System capability: SystemCapability.PowerManager.PowerManager.Core

Required permission: ohos.permission.RUNNING_LOCK

Parameters

Example

runningLock.create('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.create⁹⁺

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

Creates a RunningLock object.

System capability: SystemCapability.PowerManager.PowerManager.Core

Required permission: ohos.permission.RUNNING_LOCK

Parameters

Return value

Example

runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then((lock: runningLock.RunningLock) => {
    console.info('created running lock: ' + lock);
})
.catch((err: { code: number, message: string }) => {
    console.error('create running lock failed, error: ' + err);
});

runningLock.isRunningLockTypeSupported^(deprecated)

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

NOTE
This API is deprecated since API version 9. You are advised to use runningLock.isSupported.

Checks whether the specified type of RunningLock is supported. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.PowerManager.PowerManager.Core

Parameters

Example

runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND, (err: Error, data: boolean) => {
    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>

NOTE
This API is deprecated since API version 9. You are advised to use runningLock.isSupported.

Checks whether the specified type of RunningLock is supported. This API uses a promise to return the result.

System capability: SystemCapability.PowerManager.PowerManager.Core

Parameters

Return value

Example

runningLock.isRunningLockTypeSupported(runningLock.RunningLockType.BACKGROUND)
.then((data: boolean) => {
    console.info('BACKGROUND lock support status: ' + data);
})
.catch((err: { code: number, message: string }) => {
    console.log('check BACKGROUND lock support status failed, err: ' + err);
});

runningLock.createRunningLock^(deprecated)

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

NOTE
This API is deprecated since API version 9. You are advised to use runningLock.create.

Creates a RunningLock object.

System capability: SystemCapability.PowerManager.PowerManager.Core

Required permission: ohos.permission.RUNNING_LOCK

Parameters

Example

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)

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

NOTE
This API is deprecated since API version 9. You are advised to use runningLock.create.

Creates a RunningLock object.

System capability: SystemCapability.PowerManager.PowerManager.Core

Required permission: ohos.permission.RUNNING_LOCK

Parameters

Return value

Example

runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then((lock: runningLock.RunningLock) => {
    console.info('created running lock: ' + lock);
})
.catch((err: { code: number, message: string }) => {
    console.log('create running lock failed, err: ' + err);
});

RunningLock

Defines a RunningLock object.

hold⁹⁺

hold(timeout: number): void

Locks and holds a RunningLock object.

System capability: SystemCapability.PowerManager.PowerManager.Core

Required permission: ohos.permission.RUNNING_LOCK

Parameters

Error codes

For details about the error codes, see RunningLock Error Codes.

Example

runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then((lock: runningLock.RunningLock) => {
    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: { code: number, message: string }) => {
    console.error('create running lock failed, err: ' + err);
});

unhold⁹⁺

unhold(): void

Releases a RunningLock object.

System capability: SystemCapability.PowerManager.PowerManager.Core

Required permission: ohos.permission.RUNNING_LOCK

Error codes

For details about the error codes, see RunningLock Error Codes.

Example

runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then((lock: runningLock.RunningLock) => {
    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: { code: number, message: string }) => {
    console.error('create running lock failed, err: ' + err);
});

isHolding⁹⁺

isHolding(): boolean

Checks the hold status of the Runninglock object.

System capability: SystemCapability.PowerManager.PowerManager.Core

Return value

Error codes

For details about the error codes, see RunningLock Error Codes.

Example

runningLock.create('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then((lock: runningLock.RunningLock) => {
    console.info('create running lock success');
    try {
        let 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: { code: number, message: string }) => {
    console.error('create running lock failed, err: ' + err);
});

lock^(deprecated)

lock(timeout: number): void

NOTE
This API is deprecated since API version 9. You are advised to use RunningLock.hold.

Locks and holds a RunningLock object.

System capability: SystemCapability.PowerManager.PowerManager.Core

Required permission: ohos.permission.RUNNING_LOCK

Parameters

Example

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: { code: number, message: string }) => {
    console.error('create running lock failed, err: ' + err);
});

unlock^(deprecated)

unlock(): void

NOTE
This API is deprecated since API version 9. You are advised to use RunningLock.unhold.

Releases a RunningLock object.

System capability: SystemCapability.PowerManager.PowerManager.Core

Required permission: ohos.permission.RUNNING_LOCK

Example

runningLock.createRunningLock('running_lock_test', runningLock.RunningLockType.BACKGROUND)
.then((lock: runningLock.RunningLock) => {
    lock.unlock();
    console.info('create running lock and unlock success');
})
.catch((err: { code: number, message: string }) => {
    console.error('create running lock failed, err: ' + err);
});

isUsed^(deprecated)

isUsed(): boolean

NOTE
This API is deprecated since API version 9. You are advised to use RunningLock.isHolding.

Checks the hold status of the Runninglock object.

System capability: SystemCapability.PowerManager.PowerManager.Core

Return value |Type |Description | |——-|————————————————————| |boolean|The value true indicates that the Runninglock object is held; and the value false indicates that the Runninglock object is released.|

Example

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: { code: number, message: string }) => {
    console.error('check running lock used status failed, err: ' + err);
});

RunningLockType

Enumerates the types of RunningLock objects.

System capability: SystemCapability.PowerManager.PowerManager.Core

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

harmony 鸿蒙System Common Events (To Be Deprecated Soon)

harmony 鸿蒙System Common Events

harmony 鸿蒙API Reference Document Description

harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)

harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)

harmony 鸿蒙@ohos.bundle (Bundle)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)