akasha

Class ServiceWorkerGlobalScope

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.WorkerGlobalScope

akasha.ServiceWorkerGlobalScope

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="ServiceWorkerGlobalScope")
public class ServiceWorkerGlobalScope
extends WorkerGlobalScope

The ServiceWorkerGlobalScope interface of the Service Worker API represents the global execution context of a service worker.

See Also:

ServiceWorkerGlobalScope - MDN, # serviceworkerglobalscope-interface

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable ExtendableEventHandler	onactivate The onactivate property of the ServiceWorkerGlobalScope interface is an event handler fired whenever an activate event occurs (when the service worker activates).
@JsNullable FetchEventHandler	onfetch The onfetch property of the ServiceWorkerGlobalScope interface is an event handler fired whenever a fetch event occurs (usually when the WindowOrWorkerGlobalScope.fetch() method is called.)
@JsNullable ExtendableEventHandler	oninstall The oninstall property of the ServiceWorkerGlobalScope interface is an event handler fired whenever an install event occurs (when the service worker installs).
@JsNullable ExtendableMessageEventHandler	onmessage The onmessage property of the ServiceWorkerGlobalScope interface is an event handler fired whenever a message event occurs — when incoming messages are received.
@JsNullable MessageEventHandler	onmessageerror The onmessageerror event handler of the WindowEventHandlers interface is an EventListener, called whenever an MessageEvent of type messageerror is fired on a window—that is, when it receives a message that cannot be deserialized.
@JsNullable NotificationEventHandler	onnotificationclick The ServiceWorkerGlobalScope.onnotificationclick property is an event handler called whenever the notificationclick event is dispatched on the ServiceWorkerGlobalScope object, that is when a user clicks on a displayed notification spawned by ServiceWorkerRegistration.showNotification().
@JsNullable NotificationEventHandler	onnotificationclose The ServiceWorkerGlobalScope.onnotificationclose property is an event handler called whenever the notificationclose event is dispatched on the ServiceWorkerGlobalScope object, that is when a user closes a displayed notification spawned by ServiceWorkerRegistration.showNotification().
@JsNullable PushEventHandler	onpush The ServiceWorkerGlobalScope.onpush event of the ServiceWorkerGlobalScope interface is fired whenever a push message is received by a service worker via a push server.
@JsNullable PushSubscriptionChangeEventHandler	onpushsubscriptionchange The ServiceWorkerGlobalScope.onpushsubscriptionchange event of the ServiceWorkerGlobalScope interface is fired to indicate a change in push subscription that was triggered outside the application's control, e.g.
@JsNullable SyncEventHandler	onsync

Fields inherited from class akasha.WorkerGlobalScope

onerror, onlanguagechange, onoffline, ononline, onrejectionhandled, onunhandledrejection

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceWorkerGlobalScope()

Method Summary

Modifier and Type	Method and Description
void	addActivateListener(ExtendableEventListener callback)
void	addActivateListener(ExtendableEventListener callback, AddEventListenerOptions options)
void	addActivateListener(ExtendableEventListener callback, boolean useCapture)
void	addFetchListener(FetchEventListener callback)
void	addFetchListener(FetchEventListener callback, AddEventListenerOptions options)
void	addFetchListener(FetchEventListener callback, boolean useCapture)
void	addInstallListener(ExtendableEventListener callback)
void	addInstallListener(ExtendableEventListener callback, AddEventListenerOptions options)
void	addInstallListener(ExtendableEventListener callback, boolean useCapture)
void	addMessageerrorListener(MessageEventListener callback)
void	addMessageerrorListener(MessageEventListener callback, AddEventListenerOptions options)
void	addMessageerrorListener(MessageEventListener callback, boolean useCapture)
void	addMessageListener(ExtendableMessageEventListener callback)
void	addMessageListener(ExtendableMessageEventListener callback, AddEventListenerOptions options)
void	addMessageListener(ExtendableMessageEventListener callback, boolean useCapture)
void	addNotificationclickListener(NotificationEventListener callback)
void	addNotificationclickListener(NotificationEventListener callback, AddEventListenerOptions options)
void	addNotificationclickListener(NotificationEventListener callback, boolean useCapture)
void	addNotificationcloseListener(NotificationEventListener callback)
void	addNotificationcloseListener(NotificationEventListener callback, AddEventListenerOptions options)
void	addNotificationcloseListener(NotificationEventListener callback, boolean useCapture)
void	addPushListener(PushEventListener callback)
void	addPushListener(PushEventListener callback, AddEventListenerOptions options)
void	addPushListener(PushEventListener callback, boolean useCapture)
void	addPushsubscriptionchangeListener(PushSubscriptionChangeEventListener callback)
void	addPushsubscriptionchangeListener(PushSubscriptionChangeEventListener callback, AddEventListenerOptions options)
void	addPushsubscriptionchangeListener(PushSubscriptionChangeEventListener callback, boolean useCapture)
void	addSyncListener(SyncEventListener callback)
void	addSyncListener(SyncEventListener callback, AddEventListenerOptions options)
void	addSyncListener(SyncEventListener callback, boolean useCapture)
Clients	clients() The clients read-only property of the ServiceWorkerGlobalScope interface returns the Clients object associated with the service worker.
ServiceWorkerRegistration	registration() The registration read-only property of the ServiceWorkerGlobalScope interface returns a reference to the ServiceWorkerRegistration object, which represents the service worker's registration.
void	removeActivateListener(ExtendableEventListener callback)
void	removeActivateListener(ExtendableEventListener callback, boolean useCapture)
void	removeActivateListener(ExtendableEventListener callback, EventListenerOptions options)
void	removeFetchListener(FetchEventListener callback)
void	removeFetchListener(FetchEventListener callback, boolean useCapture)
void	removeFetchListener(FetchEventListener callback, EventListenerOptions options)
void	removeInstallListener(ExtendableEventListener callback)
void	removeInstallListener(ExtendableEventListener callback, boolean useCapture)
void	removeInstallListener(ExtendableEventListener callback, EventListenerOptions options)
void	removeMessageerrorListener(MessageEventListener callback)
void	removeMessageerrorListener(MessageEventListener callback, boolean useCapture)
void	removeMessageerrorListener(MessageEventListener callback, EventListenerOptions options)
void	removeMessageListener(ExtendableMessageEventListener callback)
void	removeMessageListener(ExtendableMessageEventListener callback, boolean useCapture)
void	removeMessageListener(ExtendableMessageEventListener callback, EventListenerOptions options)
void	removeNotificationclickListener(NotificationEventListener callback)
void	removeNotificationclickListener(NotificationEventListener callback, boolean useCapture)
void	removeNotificationclickListener(NotificationEventListener callback, EventListenerOptions options)
void	removeNotificationcloseListener(NotificationEventListener callback)
void	removeNotificationcloseListener(NotificationEventListener callback, boolean useCapture)
void	removeNotificationcloseListener(NotificationEventListener callback, EventListenerOptions options)
void	removePushListener(PushEventListener callback)
void	removePushListener(PushEventListener callback, boolean useCapture)
void	removePushListener(PushEventListener callback, EventListenerOptions options)
void	removePushsubscriptionchangeListener(PushSubscriptionChangeEventListener callback)
void	removePushsubscriptionchangeListener(PushSubscriptionChangeEventListener callback, boolean useCapture)
void	removePushsubscriptionchangeListener(PushSubscriptionChangeEventListener callback, EventListenerOptions options)
void	removeSyncListener(SyncEventListener callback)
void	removeSyncListener(SyncEventListener callback, boolean useCapture)
void	removeSyncListener(SyncEventListener callback, EventListenerOptions options)
ServiceWorker	serviceWorker()
@JsNonNull Promise<java.lang.Void>	skipWaiting() The ServiceWorkerGlobalScope.skipWaiting() method of the ServiceWorkerGlobalScope forces the waiting service worker to become the active service worker.

Methods inherited from class akasha.WorkerGlobalScope

addLanguagechangeListener, addLanguagechangeListener, addLanguagechangeListener, addOfflineListener, addOfflineListener, addOfflineListener, addOnlineListener, addOnlineListener, addOnlineListener, addRejectionhandledListener, addRejectionhandledListener, addRejectionhandledListener, addUnhandledrejectionListener, addUnhandledrejectionListener, addUnhandledrejectionListener, atob, btoa, caches, clearInterval, clearInterval, clearTimeout, clearTimeout, createImageBitmap, createImageBitmap, createImageBitmap, createImageBitmap, crossOriginIsolated, crypto, fetch, fetch, fetch, fetch, fetch, fetch, importScripts, indexedDB, isIndexedDBSupported, isSecureContext, location, navigator, origin, performance, queueMicrotask, removeLanguagechangeListener, removeLanguagechangeListener, removeLanguagechangeListener, removeOfflineListener, removeOfflineListener, removeOfflineListener, removeOnlineListener, removeOnlineListener, removeOnlineListener, removeRejectionhandledListener, removeRejectionhandledListener, removeRejectionhandledListener, removeUnhandledrejectionListener, removeUnhandledrejectionListener, removeUnhandledrejectionListener, reportError, self, setInterval, setInterval, setTimeout, setTimeout, structuredClone, structuredClone

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

onactivate

public @JsNullable ExtendableEventHandler onactivate

The onactivate property of the ServiceWorkerGlobalScope interface is an event handler fired whenever an activate event occurs (when the service worker activates). This happens after installation, when the page to be controlled by the service worker refreshes.

See Also:

ServiceWorkerGlobalScope.onactivate - MDN, Event Handlers - Service Workers

onfetch

public @JsNullable FetchEventHandler onfetch

The onfetch property of the ServiceWorkerGlobalScope interface is an event handler fired whenever a fetch event occurs (usually when the WindowOrWorkerGlobalScope.fetch() method is called.)

See Also:

ServiceWorkerGlobalScope.onfetch - MDN, Event Handlers - Service Workers

oninstall

public @JsNullable ExtendableEventHandler oninstall

The oninstall property of the ServiceWorkerGlobalScope interface is an event handler fired whenever an install event occurs (when the service worker installs). This happens before activation.

See Also:

ServiceWorkerGlobalScope.oninstall - MDN, Event Handlers - Service Workers

onmessage

public @JsNullable ExtendableMessageEventHandler onmessage

The onmessage property of the ServiceWorkerGlobalScope interface is an event handler fired whenever a message event occurs — when incoming messages are received.

See Also:

ServiceWorkerGlobalScope.onmessage - MDN, Event Handlers - Service Workers

onmessageerror

public @JsNullable MessageEventHandler onmessageerror

The onmessageerror event handler of the WindowEventHandlers interface is an EventListener, called whenever an MessageEvent of type messageerror is fired on a window—that is, when it receives a message that cannot be deserialized.

See Also:

WindowEventHandlers.onmessageerror - MDN, onmessageerror - HTML Living Standard

onnotificationclick

public @JsNullable NotificationEventHandler onnotificationclick

The ServiceWorkerGlobalScope.onnotificationclick property is an event handler called whenever the notificationclick event is dispatched on the ServiceWorkerGlobalScope object, that is when a user clicks on a displayed notification spawned by ServiceWorkerRegistration.showNotification().

See Also:

ServiceWorkerGlobalScope.onnotificationclick - MDN, onnotificationclick - Notifications API

onnotificationclose

public @JsNullable NotificationEventHandler onnotificationclose

The ServiceWorkerGlobalScope.onnotificationclose property is an event handler called whenever the notificationclose event is dispatched on the ServiceWorkerGlobalScope object, that is when a user closes a displayed notification spawned by ServiceWorkerRegistration.showNotification().

See Also:

ServiceWorkerGlobalScope.onnotificationclose - MDN, onnotificationclick - Notifications API

onpush

public @JsNullable PushEventHandler onpush

The ServiceWorkerGlobalScope.onpush event of the ServiceWorkerGlobalScope interface is fired whenever a push message is received by a service worker via a push server.

See Also:

ServiceWorkerGlobalScope.onpush - MDN, onpush - Push API

onpushsubscriptionchange

public @JsNullable PushSubscriptionChangeEventHandler onpushsubscriptionchange

The ServiceWorkerGlobalScope.onpushsubscriptionchange event of the ServiceWorkerGlobalScope interface is fired to indicate a change in push subscription that was triggered outside the application's control, e.g. when browser refresh the push subscription.

See Also:

ServiceWorkerGlobalScope.onpushsubscriptionchange - MDN, onpushsubscriptionchange - Push API

onsync

public @JsNullable SyncEventHandler onsync

Constructor Detail

ServiceWorkerGlobalScope

protected ServiceWorkerGlobalScope()

Method Detail

clients

@JsProperty(name="clients")
 @Nonnull
public Clients clients()

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

See Also:

ServiceWorkerGlobalScope.clients - MDN

registration

@JsProperty(name="registration")
 @Nonnull
public ServiceWorkerRegistration registration()

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

See Also:

ServiceWorkerGlobalScope.registration - MDN

serviceWorker

@JsProperty(name="serviceWorker")
 @Nonnull
public ServiceWorker serviceWorker()

skipWaiting

public @JsNonNull Promise<java.lang.Void> skipWaiting()

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

See Also:

ServiceWorkerGlobalScope.skipWaiting - MDN, skipWaiting() - Service Workers

addActivateListener

@JsOverlay
public final void addActivateListener(@Nonnull
                                                 ExtendableEventListener callback,
                                                 @Nonnull
                                                 AddEventListenerOptions options)

addActivateListener

@JsOverlay
public final void addActivateListener(@Nonnull
                                                 ExtendableEventListener callback,
                                                 boolean useCapture)

addActivateListener

@JsOverlay
public final void addActivateListener(@Nonnull
                                                 ExtendableEventListener callback)

removeActivateListener

@JsOverlay
public final void removeActivateListener(@Nonnull
                                                    ExtendableEventListener callback,
                                                    @Nonnull
                                                    EventListenerOptions options)

removeActivateListener

@JsOverlay
public final void removeActivateListener(@Nonnull
                                                    ExtendableEventListener callback,
                                                    boolean useCapture)

removeActivateListener

@JsOverlay
public final void removeActivateListener(@Nonnull
                                                    ExtendableEventListener callback)

addInstallListener

@JsOverlay
public final void addInstallListener(@Nonnull
                                                ExtendableEventListener callback,
                                                @Nonnull
                                                AddEventListenerOptions options)

addInstallListener

@JsOverlay
public final void addInstallListener(@Nonnull
                                                ExtendableEventListener callback,
                                                boolean useCapture)

addInstallListener

@JsOverlay
public final void addInstallListener(@Nonnull
                                                ExtendableEventListener callback)

removeInstallListener

@JsOverlay
public final void removeInstallListener(@Nonnull
                                                   ExtendableEventListener callback,
                                                   @Nonnull
                                                   EventListenerOptions options)

removeInstallListener

@JsOverlay
public final void removeInstallListener(@Nonnull
                                                   ExtendableEventListener callback,
                                                   boolean useCapture)

removeInstallListener

@JsOverlay
public final void removeInstallListener(@Nonnull
                                                   ExtendableEventListener callback)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                ExtendableMessageEventListener callback,
                                                @Nonnull
                                                AddEventListenerOptions options)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                ExtendableMessageEventListener callback,
                                                boolean useCapture)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                ExtendableMessageEventListener callback)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   ExtendableMessageEventListener callback,
                                                   @Nonnull
                                                   EventListenerOptions options)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   ExtendableMessageEventListener callback,
                                                   boolean useCapture)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   ExtendableMessageEventListener callback)

addFetchListener

@JsOverlay
public final void addFetchListener(@Nonnull
                                              FetchEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addFetchListener

@JsOverlay
public final void addFetchListener(@Nonnull
                                              FetchEventListener callback,
                                              boolean useCapture)

addFetchListener

@JsOverlay
public final void addFetchListener(@Nonnull
                                              FetchEventListener callback)

removeFetchListener

@JsOverlay
public final void removeFetchListener(@Nonnull
                                                 FetchEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeFetchListener

@JsOverlay
public final void removeFetchListener(@Nonnull
                                                 FetchEventListener callback,
                                                 boolean useCapture)

removeFetchListener

@JsOverlay
public final void removeFetchListener(@Nonnull
                                                 FetchEventListener callback)

addNotificationclickListener

@JsOverlay
public final void addNotificationclickListener(@Nonnull
                                                          NotificationEventListener callback,
                                                          @Nonnull
                                                          AddEventListenerOptions options)

addNotificationclickListener

@JsOverlay
public final void addNotificationclickListener(@Nonnull
                                                          NotificationEventListener callback,
                                                          boolean useCapture)

addNotificationclickListener

@JsOverlay
public final void addNotificationclickListener(@Nonnull
                                                          NotificationEventListener callback)

removeNotificationclickListener

@JsOverlay
public final void removeNotificationclickListener(@Nonnull
                                                             NotificationEventListener callback,
                                                             @Nonnull
                                                             EventListenerOptions options)

removeNotificationclickListener

@JsOverlay
public final void removeNotificationclickListener(@Nonnull
                                                             NotificationEventListener callback,
                                                             boolean useCapture)

removeNotificationclickListener

@JsOverlay
public final void removeNotificationclickListener(@Nonnull
                                                             NotificationEventListener callback)

addPushListener

@JsOverlay
public final void addPushListener(@Nonnull
                                             PushEventListener callback,
                                             @Nonnull
                                             AddEventListenerOptions options)

addPushListener

@JsOverlay
public final void addPushListener(@Nonnull
                                             PushEventListener callback,
                                             boolean useCapture)

addPushListener

@JsOverlay
public final void addPushListener(@Nonnull
                                             PushEventListener callback)

removePushListener

@JsOverlay
public final void removePushListener(@Nonnull
                                                PushEventListener callback,
                                                @Nonnull
                                                EventListenerOptions options)

removePushListener

@JsOverlay
public final void removePushListener(@Nonnull
                                                PushEventListener callback,
                                                boolean useCapture)

removePushListener

@JsOverlay
public final void removePushListener(@Nonnull
                                                PushEventListener callback)

addPushsubscriptionchangeListener

@JsOverlay
public final void addPushsubscriptionchangeListener(@Nonnull
                                                               PushSubscriptionChangeEventListener callback,
                                                               @Nonnull
                                                               AddEventListenerOptions options)

addPushsubscriptionchangeListener

@JsOverlay
public final void addPushsubscriptionchangeListener(@Nonnull
                                                               PushSubscriptionChangeEventListener callback,
                                                               boolean useCapture)

addPushsubscriptionchangeListener

@JsOverlay
public final void addPushsubscriptionchangeListener(@Nonnull
                                                               PushSubscriptionChangeEventListener callback)

removePushsubscriptionchangeListener

@JsOverlay
public final void removePushsubscriptionchangeListener(@Nonnull
                                                                  PushSubscriptionChangeEventListener callback,
                                                                  @Nonnull
                                                                  EventListenerOptions options)

removePushsubscriptionchangeListener

@JsOverlay
public final void removePushsubscriptionchangeListener(@Nonnull
                                                                  PushSubscriptionChangeEventListener callback,
                                                                  boolean useCapture)

removePushsubscriptionchangeListener

@JsOverlay
public final void removePushsubscriptionchangeListener(@Nonnull
                                                                  PushSubscriptionChangeEventListener callback)

addMessageerrorListener

@JsOverlay
public final void addMessageerrorListener(@Nonnull
                                                     MessageEventListener callback,
                                                     @Nonnull
                                                     AddEventListenerOptions options)

addMessageerrorListener

@JsOverlay
public final void addMessageerrorListener(@Nonnull
                                                     MessageEventListener callback,
                                                     boolean useCapture)

addMessageerrorListener

@JsOverlay
public final void addMessageerrorListener(@Nonnull
                                                     MessageEventListener callback)

removeMessageerrorListener

@JsOverlay
public final void removeMessageerrorListener(@Nonnull
                                                        MessageEventListener callback,
                                                        @Nonnull
                                                        EventListenerOptions options)

removeMessageerrorListener

@JsOverlay
public final void removeMessageerrorListener(@Nonnull
                                                        MessageEventListener callback,
                                                        boolean useCapture)

removeMessageerrorListener

@JsOverlay
public final void removeMessageerrorListener(@Nonnull
                                                        MessageEventListener callback)

addSyncListener

@JsOverlay
public final void addSyncListener(@Nonnull
                                             SyncEventListener callback,
                                             @Nonnull
                                             AddEventListenerOptions options)

addSyncListener

@JsOverlay
public final void addSyncListener(@Nonnull
                                             SyncEventListener callback,
                                             boolean useCapture)

addSyncListener

@JsOverlay
public final void addSyncListener(@Nonnull
                                             SyncEventListener callback)

removeSyncListener

@JsOverlay
public final void removeSyncListener(@Nonnull
                                                SyncEventListener callback,
                                                @Nonnull
                                                EventListenerOptions options)

removeSyncListener

@JsOverlay
public final void removeSyncListener(@Nonnull
                                                SyncEventListener callback,
                                                boolean useCapture)

removeSyncListener

@JsOverlay
public final void removeSyncListener(@Nonnull
                                                SyncEventListener callback)

addNotificationcloseListener

@JsOverlay
public final void addNotificationcloseListener(@Nonnull
                                                          NotificationEventListener callback,
                                                          @Nonnull
                                                          AddEventListenerOptions options)

addNotificationcloseListener

@JsOverlay
public final void addNotificationcloseListener(@Nonnull
                                                          NotificationEventListener callback,
                                                          boolean useCapture)

addNotificationcloseListener

@JsOverlay
public final void addNotificationcloseListener(@Nonnull
                                                          NotificationEventListener callback)

removeNotificationcloseListener

@JsOverlay
public final void removeNotificationcloseListener(@Nonnull
                                                             NotificationEventListener callback,
                                                             @Nonnull
                                                             EventListenerOptions options)

removeNotificationcloseListener

@JsOverlay
public final void removeNotificationcloseListener(@Nonnull
                                                             NotificationEventListener callback,
                                                             boolean useCapture)

removeNotificationcloseListener

@JsOverlay
public final void removeNotificationcloseListener(@Nonnull
                                                             NotificationEventListener callback)