akasha

Class Clients

java.lang.Object

akasha.core.JsObject

akasha.Clients

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

The Clients interface provides access to Client objects. Access it via self.clients within a service worker.

See Also:

Clients - MDN, # clients-interface

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Clients()

Method Summary

Modifier and Type	Method and Description
@JsNonNull Promise<java.lang.Void>	claim() The claim() method of the Clients interface allows an active service worker to set itself as the controller for all clients within its scope.
@JsNonNull Promise<ClientOrUndefinedUnion>	get(java.lang.String id) The get() method of the Clients interface gets a service worker client matching a given id and returns it in a Promise.
@JsNonNull Promise<JsArray<Client>>	matchAll() The matchAll() method of the Clients interface returns a Promise for a list of service worker Client objects.
@JsNonNull Promise<JsArray<Client>>	matchAll(ClientQueryOptions options) The matchAll() method of the Clients interface returns a Promise for a list of service worker Client objects.
@JsNonNull Promise<WindowClient>	openWindow(java.lang.String url) The openWindow() method of the Clients interface creates a new top level browsing context and loads a given URL.

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

Constructor Detail

Clients

protected Clients()

Method Detail

claim

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

The claim() method of the Clients interface allows an active service worker to set itself as the controller for all clients within its scope. This triggers a "controllerchange" event on navigator.serviceWorker in any clients that become controlled by this service worker.

See Also:

Clients.claim - MDN, claim() - Service Workers

get

public @JsNonNull Promise<ClientOrUndefinedUnion> get(@Nonnull
                                                      java.lang.String id)

The get() method of the Clients interface gets a service worker client matching a given id and returns it in a Promise.

See Also:

Clients.get - MDN, get() - Service Workers

matchAll

public @JsNonNull Promise<JsArray<Client>> matchAll(@Nonnull
                                                    ClientQueryOptions options)

The matchAll() method of the Clients interface returns a Promise for a list of service worker Client objects. Include the options parameter to return all service worker clients whose origin is the same as the associated service worker's origin. If options are not included, the method returns only the service worker clients controlled by the service worker.

See Also:

Clients.matchAll - MDN, Clients: matchall - Service Workers

matchAll

public @JsNonNull Promise<JsArray<Client>> matchAll()

The matchAll() method of the Clients interface returns a Promise for a list of service worker Client objects. Include the options parameter to return all service worker clients whose origin is the same as the associated service worker's origin. If options are not included, the method returns only the service worker clients controlled by the service worker.

See Also:

Clients.matchAll - MDN, Clients: matchall - Service Workers

openWindow

public @JsNonNull Promise<WindowClient> openWindow(@Nonnull
                                                   java.lang.String url)

The openWindow() method of the Clients interface creates a new top level browsing context and loads a given URL. If the calling script doesn't have permission to show popups, openWindow() will throw an InvalidAccessError.

See Also:

Clients.openWindow - MDN, Clients: openWindow - Service Workers