akasha

Class ServiceWorkerRegistration

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.ServiceWorkerRegistration

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

The ServiceWorkerRegistration interface of the Service Worker API represents the service worker registration. You register a service worker to control one or more pages that share the same origin.

See Also:

ServiceWorkerRegistration - MDN, # serviceworkerregistration-interface, # extensions-to-the-serviceworkerregistration-interface

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable EventHandler	onupdatefound The onupdatefound property of the ServiceWorkerRegistration interface is an EventListener property called whenever an event of type statechange is fired; it is fired any time the ServiceWorkerRegistration.installing property acquires a new service worker.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceWorkerRegistration()

Method Summary

Modifier and Type	Method and Description
ServiceWorker	active() The active property of the ServiceWorkerRegistration interface returns a service worker whose ServiceWorker.state is activating or activated.
void	addUpdatefoundListener(EventListener callback)
void	addUpdatefoundListener(EventListener callback, AddEventListenerOptions options)
void	addUpdatefoundListener(EventListener callback, boolean useCapture)
@JsNonNull Promise<JsArray<Notification>>	getNotifications() The getNotifications() method of the ServiceWorkerRegistration interface returns a list of the notifications in the order that they were created from the current origin via the current service worker registration.
@JsNonNull Promise<JsArray<Notification>>	getNotifications(GetNotificationOptions filter) The getNotifications() method of the ServiceWorkerRegistration interface returns a list of the notifications in the order that they were created from the current origin via the current service worker registration.
ServiceWorker	installing() The installing property of the ServiceWorkerRegistration interface returns a service worker whose ServiceWorker.state is installing.
NavigationPreloadManager	navigationPreload() The navigationPreload read-only property of the ServiceWorkerRegistration interface returns the NavigationPreloadManager associated with the current service worker registration.
PushManager	pushManager() The pushManager property of the ServiceWorkerRegistration interface returns a reference to the PushManager interface for managing push subscriptions; this includes support for subscribing, getting an active subscription, and accessing push permission status.
void	removeUpdatefoundListener(EventListener callback)
void	removeUpdatefoundListener(EventListener callback, boolean useCapture)
void	removeUpdatefoundListener(EventListener callback, EventListenerOptions options)
java.lang.String	scope() The scope read-only property of the ServiceWorkerRegistration interface returns a unique identifier for a service worker registration.
@JsNonNull Promise<java.lang.Void>	showNotification(java.lang.String title) The showNotification() method of the ServiceWorkerRegistration interface creates a notification on an active service worker.
@JsNonNull Promise<java.lang.Void>	showNotification(java.lang.String title, NotificationOptions options) The showNotification() method of the ServiceWorkerRegistration interface creates a notification on an active service worker.
SyncManager	sync() The sync property of the ServiceWorkerRegistration interface returns a reference to the SyncManager interface, which manages background synchronization processes.
@JsNonNull Promise<java.lang.Boolean>	unregister() The unregister() method of the ServiceWorkerRegistration interface unregisters the service worker registration and returns a Promise.
@JsNonNull Promise<java.lang.Void>	update() The update() method of the ServiceWorkerRegistration interface attempts to update the service worker.
java.lang.String	updateViaCache()
ServiceWorker	waiting() The waiting property of the ServiceWorkerRegistration interface returns a service worker whose ServiceWorker.state is installed.

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

onupdatefound

public @JsNullable EventHandler onupdatefound

The onupdatefound property of the ServiceWorkerRegistration interface is an EventListener property called whenever an event of type statechange is fired; it is fired any time the ServiceWorkerRegistration.installing property acquires a new service worker.

See Also:

ServiceWorkerRegistration.onupdatefound - MDN, ServiceWorkerRegistration.onupdatefound - Service Workers

Constructor Detail

ServiceWorkerRegistration

protected ServiceWorkerRegistration()

Method Detail

active

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

The active property of the ServiceWorkerRegistration interface returns a service worker whose ServiceWorker.state is activating or activated. This property is initially set to null.

See Also:

ServiceWorkerRegistration.active - MDN

installing

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

The installing property of the ServiceWorkerRegistration interface returns a service worker whose ServiceWorker.state is installing. This property is initially set to null.

See Also:

ServiceWorkerRegistration.installing - MDN, ServiceWorkerRegistration.installing - Service Workers

navigationPreload

@JsProperty(name="navigationPreload")
 @Nonnull
public NavigationPreloadManager navigationPreload()

The navigationPreload read-only property of the ServiceWorkerRegistration interface returns the NavigationPreloadManager associated with the current service worker registration.

See Also:

ServiceWorkerRegistration.navigationPreload - MDN, navigationPreload - Service Workers

pushManager

@JsProperty(name="pushManager")
 @Nonnull
public PushManager pushManager()

The pushManager property of the ServiceWorkerRegistration interface returns a reference to the PushManager interface for managing push subscriptions; this includes support for subscribing, getting an active subscription, and accessing push permission status.

See Also:

ServiceWorkerRegistration.pushManager - MDN, PushManager - Push API

scope

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

The scope read-only property of the ServiceWorkerRegistration interface returns a unique identifier for a service worker registration. The service worker must be on the same origin as the document that registers the ServiceWorker.

See Also:

ServiceWorkerRegistration.scope - MDN, ServiceWorkerRegistration.scope - Service Workers

sync

@JsProperty(name="sync")
 @Nonnull
public SyncManager sync()

The sync property of the ServiceWorkerRegistration interface returns a reference to the SyncManager interface, which manages background synchronization processes.

See Also:

ServiceWorkerRegistration.sync - MDN, Web Background Synchronization

updateViaCache

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

waiting

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

The waiting property of the ServiceWorkerRegistration interface returns a service worker whose ServiceWorker.state is installed. This property is initially set to null.

See Also:

ServiceWorkerRegistration.waiting - MDN

unregister

public @JsNonNull Promise<java.lang.Boolean> unregister()

The unregister() method of the ServiceWorkerRegistration interface unregisters the service worker registration and returns a Promise. The promise will resolve to false if no registration was found, otherwise it resolves to true irrespective of whether unregistration happened or not (it may not unregister if someone else just called ServiceWorkerContainer.register() with the same scope.) The service worker will finish any ongoing operations before it is unregistered.

See Also:

ServiceWorkerRegistration.unregister - MDN, ServiceWorkerRegistration.unregister() - Service Workers

update

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

The update() method of the ServiceWorkerRegistration interface attempts to update the service worker. It fetches the worker's script URL, and if the new worker is not byte-by-byte identical to the current worker, it installs the new worker. The fetch of the worker bypasses any browser caches if the previous fetch occurred over 24 hours ago.

See Also:

ServiceWorkerRegistration.update - MDN, ServiceWorkerRegistration.update() - Service Workers

getNotifications

public @JsNonNull Promise<JsArray<Notification>> getNotifications(@Nonnull
                                                                  GetNotificationOptions filter)

The getNotifications() method of the ServiceWorkerRegistration interface returns a list of the notifications in the order that they were created from the current origin via the current service worker registration. Origins can have many active but differently-scoped service worker registrations. Notifications created by one service worker on the same origin will not be available to other active services workers on that same origin.

See Also:

ServiceWorkerRegistration.getNotifications - MDN, ServiceWorkerRegistration.getNotifications() - Notifications API

getNotifications

public @JsNonNull Promise<JsArray<Notification>> getNotifications()

The getNotifications() method of the ServiceWorkerRegistration interface returns a list of the notifications in the order that they were created from the current origin via the current service worker registration. Origins can have many active but differently-scoped service worker registrations. Notifications created by one service worker on the same origin will not be available to other active services workers on that same origin.

See Also:

ServiceWorkerRegistration.getNotifications - MDN, ServiceWorkerRegistration.getNotifications() - Notifications API

showNotification

public @JsNonNull Promise<java.lang.Void> showNotification(@Nonnull
                                                           java.lang.String title,
                                                           @Nonnull
                                                           NotificationOptions options)

The showNotification() method of the ServiceWorkerRegistration interface creates a notification on an active service worker.

See Also:

ServiceWorkerRegistration.showNotification - MDN, showNotification() - Notifications API

showNotification

public @JsNonNull Promise<java.lang.Void> showNotification(@Nonnull
                                                           java.lang.String title)

The showNotification() method of the ServiceWorkerRegistration interface creates a notification on an active service worker.

See Also:

ServiceWorkerRegistration.showNotification - MDN, showNotification() - Notifications API

addUpdatefoundListener

@JsOverlay
public final void addUpdatefoundListener(@Nonnull
                                                    EventListener callback,
                                                    @Nonnull
                                                    AddEventListenerOptions options)

addUpdatefoundListener

@JsOverlay
public final void addUpdatefoundListener(@Nonnull
                                                    EventListener callback,
                                                    boolean useCapture)

addUpdatefoundListener

@JsOverlay
public final void addUpdatefoundListener(@Nonnull
                                                    EventListener callback)

removeUpdatefoundListener

@JsOverlay
public final void removeUpdatefoundListener(@Nonnull
                                                       EventListener callback,
                                                       @Nonnull
                                                       EventListenerOptions options)

removeUpdatefoundListener

@JsOverlay
public final void removeUpdatefoundListener(@Nonnull
                                                       EventListener callback,
                                                       boolean useCapture)

removeUpdatefoundListener

@JsOverlay
public final void removeUpdatefoundListener(@Nonnull
                                                       EventListener callback)