kotlin-web/web.locks/LockManager

LockManager

open class LockManager(source)

The LockManager interface of the Web Locks API provides methods for requesting a new Lock object and querying for an existing Lock object. To get an instance of LockManager, call navigator.locks. Available only in secure contexts.

MDN Reference

Functions

Link copied to clipboard
inline suspend fun LockManager.query(): LockManagerSnapshot

The query() method of the LockManager interface returns a Promise that resolves with an object containing information about held and pending locks.

Link copied to clipboard
fun queryAsync(): Promise<LockManagerSnapshot>

The query() method of the LockManager interface returns a Promise that resolves with an object containing information about held and pending locks.

Link copied to clipboard
inline suspend fun <T : JsAny?> LockManager.request(name: String, noinline callback: LockGrantedCallback<T>): T

The request() method of the LockManager interface requests a Lock object with parameters specifying its name and characteristics. The requested Lock is passed to a callback, while the function itself returns a Promise that resolves (or rejects) with the result of the callback after the lock is released, or rejects if the request is aborted.

inline suspend fun <T : JsAny?> LockManager.request(name: String, options: LockOptions, noinline callback: LockGrantedCallback<T>): T
Link copied to clipboard
fun <T : JsAny?> requestAsync(name: String, callback: LockGrantedCallback<T>): Promise<T>

The request() method of the LockManager interface requests a Lock object with parameters specifying its name and characteristics. The requested Lock is passed to a callback, while the function itself returns a Promise that resolves (or rejects) with the result of the callback after the lock is released, or rejects if the request is aborted.

fun <T : JsAny?> requestAsync(name: String, options: LockOptions, callback: LockGrantedCallback<T>): Promise<T>