kotlin-browser/web.serviceworker/ServiceWorkerContainer

ServiceWorkerContainer

class ServiceWorkerContainer : EventTarget(source)

The ServiceWorkerContainer interface of the Service Worker API provides an object representing the service worker as an overall unit in the network ecosystem, including facilities to register, unregister and update service workers, and access the state of service workers and their registrations. Available only in secure contexts.

MDN Reference

Properties

controller

val controller: ServiceWorker?

The controller read-only property of the ServiceWorkerContainer interface returns a activated (the same object returned by null if the request is a force refresh (Shift + refresh) or if there is no active worker.

controllerChangeEvent

val ServiceWorkerContainer.controllerChangeEvent: EventInstance<Event, ServiceWorkerContainer, ServiceWorkerContainer>

MDN Reference

messageErrorEvent

val ServiceWorkerContainer.messageErrorEvent: EventInstance<MessageEvent<JsAny?>, ServiceWorkerContainer, ServiceWorkerContainer>

MDN Reference

messageEvent

val ServiceWorkerContainer.messageEvent: EventInstance<MessageEvent<JsAny?>, ServiceWorkerContainer, ServiceWorkerContainer>

MDN Reference

oncontrollerchange

var oncontrollerchange: EventHandler<Event, ServiceWorkerContainer, ServiceWorkerContainer>?

MDN Reference

onmessage

var onmessage: EventHandler<MessageEvent<*>, ServiceWorkerContainer, ServiceWorkerContainer>?

MDN Reference

onmessageerror

var onmessageerror: EventHandler<MessageEvent<*>, ServiceWorkerContainer, ServiceWorkerContainer>?

MDN Reference

ready

val ready: Promise<ServiceWorkerRegistration>

The ready read-only property of the ServiceWorkerContainer interface provides a way of delaying code execution until a service worker is active.

Functions

dispatchEvent

fun dispatchEvent(event: Event): Boolean

getRegistration

suspend fun getRegistration(clientURL: String = definedExternally): ServiceWorkerRegistration?

The getRegistration() method of the client URL.

suspend fun getRegistration(clientURL: URL): ServiceWorkerRegistration?

getRegistrationAsync

fun getRegistrationAsync(clientURL: String = definedExternally): Promise<ServiceWorkerRegistration?>

fun getRegistrationAsync(clientURL: URL): Promise<ServiceWorkerRegistration?>

getRegistrations

suspend fun getRegistrations(): ReadonlyArray<ServiceWorkerRegistration>

The getRegistrations() method of the ServiceWorkerContainer, in an array.

getRegistrationsAsync

fun getRegistrationsAsync(): Promise<ReadonlyArray<ServiceWorkerRegistration>>

suspend fun register(scriptURL: String, options: RegistrationOptions = definedExternally): ServiceWorkerRegistration

The register() method of the ServiceWorkerContainer interface creates or updates a ServiceWorkerRegistration for the given scope.

suspend fun register(scriptURL: URL, options: RegistrationOptions = definedExternally): ServiceWorkerRegistration

registerAsync

fun registerAsync(scriptURL: String, options: RegistrationOptions = definedExternally): Promise<ServiceWorkerRegistration>

fun registerAsync(scriptURL: URL, options: RegistrationOptions = definedExternally): Promise<ServiceWorkerRegistration>

startMessages

fun startMessages()

The startMessages() method of the ServiceWorkerContainer interface explicitly starts the flow of messages being dispatched from a service worker to pages under its control (e.g., sent via Client.postMessage()).

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>