akasha

Class ServiceWorker

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.ServiceWorker

All Implemented Interfaces:

ExtendableMessageEventSource, MessageEventSource

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

The ServiceWorker interface of the Service Worker API provides a reference to a service worker. Multiple browsing contexts (e.g. pages, workers, etc.) can be associated with the same service worker, each through a unique ServiceWorker object.

See Also:

ServiceWorker - MDN, # serviceworker-interface

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable ErrorEventHandler	onerror The AbstractWorker.onerror property of the AbstractWorker interface represents an EventHandler, that is a function to be called when the error event occurs and bubbles through the Worker.
@JsNullable EventHandler	onstatechange An EventListener property called whenever an event of type statechange is fired; it is basically fired anytime the ServiceWorker.state changes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceWorker()

Method Summary

Modifier and Type	Method and Description
void	addErrorListener(ErrorEventListener callback)
void	addErrorListener(ErrorEventListener callback, AddEventListenerOptions options)
void	addErrorListener(ErrorEventListener callback, boolean useCapture)
void	postMessage(java.lang.Object message)
void	postMessage(java.lang.Object message, JsArray<Transferable> transfer)
void	postMessage(java.lang.Object message, StructuredSerializeOptions options)
void	postMessage(java.lang.Object message, Transferable[] transfer)
void	removeErrorListener(ErrorEventListener callback)
void	removeErrorListener(ErrorEventListener callback, boolean useCapture)
void	removeErrorListener(ErrorEventListener callback, EventListenerOptions options)
java.lang.String	scriptURL() Returns the ServiceWorker serialized script URL defined as part of ServiceWorkerRegistration.
java.lang.String	state() The state read-only property of the ServiceWorker interface returns a string representing the current state of the service worker.

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

onerror

public @JsNullable ErrorEventHandler onerror

The AbstractWorker.onerror property of the AbstractWorker interface represents an EventHandler, that is a function to be called when the error event occurs and bubbles through the Worker.

See Also:

ServiceWorker.onerror - MDN, AbstractWorker.onerror - HTML Living Standard

onstatechange

public @JsNullable EventHandler onstatechange

An EventListener property called whenever an event of type statechange is fired; it is basically fired anytime the ServiceWorker.state changes.

See Also:

ServiceWorker.onstatechange - MDN, ServiceWorker.onstatechange - Service Workers

Constructor Detail

ServiceWorker

protected ServiceWorker()

Method Detail

scriptURL

@JsProperty(name="scriptURL")
 @Nonnull
public java.lang.String scriptURL()

Returns the ServiceWorker serialized script URL defined as part of ServiceWorkerRegistration. Must be on the same origin as the document that registers the ServiceWorker.

See Also:

ServiceWorker.scriptURL - MDN, scriptURL - Service Workers

state

@JsProperty(name="state")
 @Nonnull
 @ServiceWorkerState
public java.lang.String state()

The state read-only property of the ServiceWorker interface returns a string representing the current state of the service worker. It can be one of the following values: installing, installed, activating, activated, or redundant.

See Also:

ServiceWorker.state - MDN, state - Service Workers

postMessage

public void postMessage(@Nullable
                        java.lang.Object message,
                        @Nonnull
                        JsArray<Transferable> transfer)

postMessage

public void postMessage(@Nullable
                        java.lang.Object message,
                        @Nonnull
                        Transferable[] transfer)

postMessage

public void postMessage(@Nullable
                        java.lang.Object message,
                        @Nonnull
                        StructuredSerializeOptions options)

postMessage

public void postMessage(@Nullable
                        java.lang.Object message)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              ErrorEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              ErrorEventListener callback,
                                              boolean useCapture)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              ErrorEventListener callback)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 ErrorEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 ErrorEventListener callback,
                                                 boolean useCapture)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 ErrorEventListener callback)