kotlin-browser/web.serviceworker/ServiceWorkerGlobalScope

ServiceWorkerGlobalScope

open class ServiceWorkerGlobalScope : WorkerGlobalScope(source)

The ServiceWorkerGlobalScope interface of the Service Worker API represents the global execution context of a service worker. Available only in secure contexts.

MDN Reference

Properties

clients

val clients: Clients

The clients read-only property of the ServiceWorkerGlobalScope interface returns the Clients object associated with the service worker.

cookieStore

val cookieStore: CookieStore

The cookieStore read-only property of the ServiceWorkerGlobalScope interface returns a reference to the CookieStore object associated with this service worker.

fonts

open val fonts: FontFaceSet

MDN Reference

location

val location: WorkerLocation

The read-only location property of the WorkerGlobalScope interface returns the WorkerLocation associated with the worker. It is a specific location object, mostly a subset of the Location for browsing scopes, but adapted to workers.

navigator

val navigator: WorkerNavigator

The navigator read-only property of the WorkerGlobalScope interface returns the WorkerNavigator associated with the worker. It is a specific navigator object, mostly a subset of the Navigator for browsing scopes, but adapted to workers.

onactivate

var onactivate: EventHandler<ExtendableEvent, ServiceWorkerGlobalScope, ServiceWorkerGlobalScope>?

MDN Reference

oncookiechange

var oncookiechange: EventHandler<ExtendableCookieChangeEvent, ServiceWorkerGlobalScope, ServiceWorkerGlobalScope>?

MDN Reference

onerror

var onerror: EventHandler<ErrorEvent, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

onfetch

var onfetch: EventHandler<FetchEvent, ServiceWorkerGlobalScope, ServiceWorkerGlobalScope>?

MDN Reference

oninstall

var oninstall: EventHandler<ExtendableEvent, ServiceWorkerGlobalScope, ServiceWorkerGlobalScope>?

MDN Reference

onlanguagechange

var onlanguagechange: EventHandler<Event, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

onmessage

var onmessage: EventHandler<ExtendableMessageEvent, ServiceWorkerGlobalScope, ServiceWorkerGlobalScope>?

MDN Reference

onmessageerror

var onmessageerror: EventHandler<ExtendableMessageEvent, ServiceWorkerGlobalScope, ServiceWorkerGlobalScope>?

MDN Reference

onnotificationclick

var onnotificationclick: EventHandler<NotificationEvent, ServiceWorkerGlobalScope, ServiceWorkerGlobalScope>?

MDN Reference

onnotificationclose

var onnotificationclose: EventHandler<NotificationEvent, ServiceWorkerGlobalScope, ServiceWorkerGlobalScope>?

MDN Reference

onoffline

var onoffline: EventHandler<Event, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

ononline

var ononline: EventHandler<Event, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

onpush

var onpush: EventHandler<PushEvent, ServiceWorkerGlobalScope, ServiceWorkerGlobalScope>?

MDN Reference

onpushsubscriptionchange

var onpushsubscriptionchange: EventHandler<PushSubscriptionChangeEvent, ServiceWorkerGlobalScope, ServiceWorkerGlobalScope>?

MDN Reference

onrejectionhandled

var onrejectionhandled: EventHandler<PromiseRejectionEvent, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

onunhandledrejection

var onunhandledrejection: EventHandler<PromiseRejectionEvent, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

registration

val registration: ServiceWorkerRegistration

The registration read-only property of the ServiceWorkerGlobalScope interface returns a reference to the ServiceWorkerRegistration object, which represents the service worker's registration.

serviceWorker

val serviceWorker: ServiceWorker

The serviceWorker read-only property of the ServiceWorkerGlobalScope interface returns a reference to the ServiceWorker object, which represents the service worker.

Functions

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

get

open operator fun get(key: String): JsAny?

open operator fun get(key: PropertyKey): JsAny?

set

open operator fun set(key: String, value: JsAny?)

open operator fun set(key: PropertyKey, value: JsAny?)

skipWaiting

inline suspend fun ServiceWorkerGlobalScope.skipWaiting()

The skipWaiting() method of the ServiceWorkerGlobalScope interface forces the waiting service worker to become the active service worker.

skipWaitingAsync

fun skipWaitingAsync(): Promise<Void?>

The skipWaiting() method of the ServiceWorkerGlobalScope interface forces the waiting service worker to become the active service worker.

when

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