kotlin-browser/web.serviceworker/ServiceWorkerContainer

ServiceWorkerContainer

external class ServiceWorkerContainer : EventTarget(source)

The ServiceWorkerContainer interface of the ServiceWorker 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.

Properties

val controller: ServiceWorker?

controllerChangeEvent

val controllerChangeEvent: EventInstance<Event, ServiceWorkerContainer, ServiceWorkerContainer>

messageErrorEvent

val messageErrorEvent: EventInstance<MessageEvent<Any?>, ServiceWorkerContainer, ServiceWorkerContainer>

val messageEvent: EventInstance<MessageEvent<Any?>, ServiceWorkerContainer, ServiceWorkerContainer>

oncontrollerchange

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

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

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

val ready: Promise<ServiceWorkerRegistration>

Functions

fun dispatchEvent(event: Event): Boolean

getRegistration

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

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>

getRegistrationsAsync

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

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

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

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

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

fun startMessages()