akasha

Class ServiceWorkerContainer

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.ServiceWorkerContainer

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

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.

See Also:

ServiceWorkerContainer - MDN, ServiceWorkerContainer - Service Workers

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	oncontrollerchange The oncontrollerchange property of the ServiceWorkerContainer interface is an event handler fired whenever a controllerchange event occurs — when the document's associated ServiceWorkerRegistration acquires a new active worker.
MessageEventHandler	onmessage The onmessage property of the ServiceWorkerContainer interface is an event handler fired whenever a message event occurs — when incoming messages are received to the ServiceWorkerContainer object (e.g., via a Client.postMessage() call).
EventHandler	onmessageerror

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceWorkerContainer()

Method Summary

Modifier and Type	Method and Description
void	addMessageListener(MessageEventListener callback)
void	addMessageListener(MessageEventListener callback, AddEventListenerOptions options)
void	addMessageListener(MessageEventListener callback, boolean useCapture)
ServiceWorker	controller() The controller read-only property of the ServiceWorkerContainer interface returns a ServiceWorker object if its state is activating or activated (the same object returned by ServiceWorkerRegistration.active).
Promise<ServiceWorkerRegistrationOrUndefinedUnion>	getRegistration() The getRegistration() method of the ServiceWorkerContainer interface gets a ServiceWorkerRegistration object whose scope URL matches the provided document URL.
Promise<ServiceWorkerRegistrationOrUndefinedUnion>	getRegistration(java.lang.String clientURL) The getRegistration() method of the ServiceWorkerContainer interface gets a ServiceWorkerRegistration object whose scope URL matches the provided document URL.
Promise<JsArray<ServiceWorkerRegistration>>	getRegistrations() The getRegistrations() method of the ServiceWorkerContainer interface gets all ServiceWorkerRegistrations associated with a ServiceWorkerContainer, in an array.
Promise<ServiceWorkerRegistration>	ready() The ready read-only property of the ServiceWorkerContainer interface provides a way of delaying code execution until a service worker is active.
Promise<ServiceWorkerRegistration>	register(java.lang.String scriptURL) The register() method of the ServiceWorkerContainer interface creates or updates a ServiceWorkerRegistration for the given scriptURL.
Promise<ServiceWorkerRegistration>	register(java.lang.String scriptURL, RegistrationOptions options) The register() method of the ServiceWorkerContainer interface creates or updates a ServiceWorkerRegistration for the given scriptURL.
void	removeMessageListener(MessageEventListener callback)
void	removeMessageListener(MessageEventListener callback, boolean useCapture)
void	removeMessageListener(MessageEventListener callback, EventListenerOptions options)
void	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.

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, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object

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

Field Detail

oncontrollerchange

@Nullable
public EventHandler oncontrollerchange

The oncontrollerchange property of the ServiceWorkerContainer interface is an event handler fired whenever a controllerchange event occurs — when the document's associated ServiceWorkerRegistration acquires a new active worker.

See Also:

ServiceWorkerContainer.oncontrollerchange - MDN, ServiceWorkerContainer: oncontrollerchange - Service Workers

onmessage

@Nullable
public MessageEventHandler onmessage

The onmessage property of the ServiceWorkerContainer interface is an event handler fired whenever a message event occurs — when incoming messages are received to the ServiceWorkerContainer object (e.g., via a Client.postMessage() call).

See Also:

ServiceWorkerContainer.onmessage - MDN, ServiceWorkerContainer: onmessage - Service Workers

onmessageerror

@Nullable
public EventHandler onmessageerror

Constructor Detail

ServiceWorkerContainer

protected ServiceWorkerContainer()

Method Detail

controller

@JsProperty(name="controller")
 @Nullable
public ServiceWorker controller()

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

See Also:

ServiceWorkerContainer.controller - MDN, ServiceWorkerRegistration.controller - Service Workers

ready

@JsProperty(name="ready")
 @Nonnull
public Promise<ServiceWorkerRegistration> ready()

The ready read-only property of the ServiceWorkerContainer interface provides a way of delaying code execution until a service worker is active. It returns a Promise that will never reject, and which waits indefinitely until the ServiceWorkerRegistration associated with the current page has an active worker. Once that condition is met, it resolves with the ServiceWorkerRegistration.

See Also:

ServiceWorkerContainer.ready - MDN, ServiceWorkerRegistration.ready - Service Workers

getRegistration

@Nonnull
public Promise<ServiceWorkerRegistrationOrUndefinedUnion> getRegistration(@Nonnull
                                                                                   java.lang.String clientURL)

The getRegistration() method of the ServiceWorkerContainer interface gets a ServiceWorkerRegistration object whose scope URL matches the provided document URL. The method returns a Promise that resolves to a ServiceWorkerRegistration or undefined.

See Also:

ServiceWorkerContainer.getRegistration - MDN, ServiceWorkerContainer: getRegistration - Service Workers

getRegistration

@Nonnull
public Promise<ServiceWorkerRegistrationOrUndefinedUnion> getRegistration()

The getRegistration() method of the ServiceWorkerContainer interface gets a ServiceWorkerRegistration object whose scope URL matches the provided document URL. The method returns a Promise that resolves to a ServiceWorkerRegistration or undefined.

See Also:

ServiceWorkerContainer.getRegistration - MDN, ServiceWorkerContainer: getRegistration - Service Workers

getRegistrations

@Nonnull
public Promise<JsArray<ServiceWorkerRegistration>> getRegistrations()

The getRegistrations() method of the ServiceWorkerContainer interface gets all ServiceWorkerRegistrations associated with a ServiceWorkerContainer, in an array. The method returns a Promise that resolves to an array of ServiceWorkerRegistration.

See Also:

ServiceWorkerContainer.getRegistrations - MDN, getRegistrations() - Service Workers

register

@Nonnull
public Promise<ServiceWorkerRegistration> register(@Nonnull
                                                            java.lang.String scriptURL,
                                                            @Nonnull
                                                            RegistrationOptions options)

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

See Also:

ServiceWorkerContainer.register - MDN, ServiceWorkerContainer: register - Service Workers

register

@Nonnull
public Promise<ServiceWorkerRegistration> register(@Nonnull
                                                            java.lang.String scriptURL)

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

See Also:

ServiceWorkerContainer.register - MDN, ServiceWorkerContainer: register - Service Workers

startMessages

public void 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()). This can be used to react to sent messages earlier, even before that page's content has finished loading.

See Also:

ServiceWorkerContainer.startMessages - MDN, ServiceWorkerContainer: startMessages() - Service Workers

addMessageListener

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

addMessageListener

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

addMessageListener

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

removeMessageListener

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

removeMessageListener

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

removeMessageListener

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