kotlin-browser/web.serviceworker/ServiceWorkerContainer

ServiceWorkerContainer

open 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 represents the active ServiceWorker controlling the current page (associated with this ServiceWorkerContainer), or null if the page has no active or activating service worker.

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

inline suspend fun ServiceWorkerContainer.getRegistration(): ServiceWorkerRegistration?

inline suspend fun ServiceWorkerContainer.getRegistration(clientURL: String): ServiceWorkerRegistration?

The getRegistration() method of the ServiceWorkerContainer interface gets a ServiceWorkerRegistration object whose scope URL matches the provided client URL.

inline suspend fun ServiceWorkerContainer.getRegistration(clientURL: URL): ServiceWorkerRegistration?

getRegistrationAsync

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

The getRegistration() method of the ServiceWorkerContainer interface gets a ServiceWorkerRegistration object whose scope URL matches the provided client URL.

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

getRegistrations

inline suspend fun ServiceWorkerContainer.getRegistrations(): ReadonlyArray<ServiceWorkerRegistration>

The getRegistrations() method of the ServiceWorkerContainer interface gets all ServiceWorkerRegistrations associated with a ServiceWorkerContainer, in an array.

getRegistrationsAsync

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

The getRegistrations() method of the ServiceWorkerContainer interface gets all ServiceWorkerRegistrations associated with a ServiceWorkerContainer, in an array.

inline suspend fun ServiceWorkerContainer.register(scriptURL: String): ServiceWorkerRegistration

inline suspend fun ServiceWorkerContainer.register(scriptURL: String, options: RegistrationOptions): ServiceWorkerRegistration

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

inline suspend fun ServiceWorkerContainer.register(module: ServiceWorkerModule): ServiceWorkerRegistration

inline suspend fun ServiceWorkerContainer.register(scriptURL: URL): ServiceWorkerRegistration

inline suspend fun ServiceWorkerContainer.register(module: ServiceWorkerModule, options: RegistrationOptions): ServiceWorkerRegistration

inline suspend fun ServiceWorkerContainer.register(scriptURL: URL, options: RegistrationOptions): ServiceWorkerRegistration

registerAsync

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

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

fun registerAsync(module: ServiceWorkerModule, 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>