kotlin-browser/web.serviceworker/Clients

Clients

The Clients interface provides access to Client objects.

Functions

inline suspend fun Clients.claim()

The claim() method of the Clients interface allows an active service worker to set itself as the ServiceWorkerContainer.controller for all clients within its ServiceWorkerRegistration.scope.

claimAsync

fun claimAsync(): Promise<Void?>

The claim() method of the Clients interface allows an active service worker to set itself as the ServiceWorkerContainer.controller for all clients within its ServiceWorkerRegistration.scope.

get

inline suspend fun Clients.get(id: String): Client?

The get() method of the Clients interface gets a service worker client matching a given id and returns it in a Promise.

getAsync

fun getAsync(id: String): Promise<Client?>

The get() method of the Clients interface gets a service worker client matching a given id and returns it in a Promise.

matchAll

inline suspend fun <T : ClientQueryOptions> Clients.matchAll(): ReadonlyArray<Client>

inline suspend fun <T : ClientQueryOptions> Clients.matchAll(options: T): ReadonlyArray<Client>

The matchAll() method of the Clients interface returns a Promise for a list of service worker Client objects.

matchAllAsync

fun <T : ClientQueryOptions> matchAllAsync(options: T = definedExternally): Promise<ReadonlyArray<Client>>

The matchAll() method of the Clients interface returns a Promise for a list of service worker Client objects.

openWindow

inline suspend fun Clients.openWindow(url: String): WindowClient?

The openWindow() method of the Clients interface creates a new top level browsing context and loads a given URL.

inline suspend fun Clients.openWindow(url: URL): WindowClient?

openWindowAsync

fun openWindowAsync(url: String): Promise<WindowClient?>

The openWindow() method of the Clients interface creates a new top level browsing context and loads a given URL.

fun openWindowAsync(url: URL): Promise<WindowClient?>