akasha

Class Client

java.lang.Object

akasha.core.JsObject

akasha.Client

All Implemented Interfaces:

ExtendableMessageEventSource

Direct Known Subclasses:

WindowClient

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

The Client interface represents an executable context such as a Worker, or a SharedWorker. Window clients are represented by the more-specific WindowClient. You can get Client/WindowClient objects from methods such as Clients.matchAll() and Clients.get().

See Also:

Client - MDN, # client-interface

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Client()

Method Summary

Modifier and Type	Method and Description
java.lang.String	frameType() The frameType read-only property of the Client interface indicates the type of browsing context of the current Client.
java.lang.String	id() The id read-only property of the Client interface returns the universally unique identifier of the Client object.
void	postMessage(java.lang.Object message) The postMessage() method of the Client interface allows a service worker to send a message to a client (a Window, Worker, or SharedWorker).
void	postMessage(java.lang.Object message, JsArray<Transferable> transfer) The postMessage() method of the Client interface allows a service worker to send a message to a client (a Window, Worker, or SharedWorker).
void	postMessage(java.lang.Object message, StructuredSerializeOptions options) The postMessage() method of the Client interface allows a service worker to send a message to a client (a Window, Worker, or SharedWorker).
void	postMessage(java.lang.Object message, Transferable... transfer) The postMessage() method of the Client interface allows a service worker to send a message to a client (a Window, Worker, or SharedWorker).
java.lang.String	type() The type read-only property of the Client interface indicates the type of client the service worker is controlling.
java.lang.String	url() The url read-only property of the Client interface returns the URL of the current service worker client.

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

Client

protected Client()

Method Detail

frameType

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

The frameType read-only property of the Client interface indicates the type of browsing context of the current Client. This value can be one of "auxiliary", "top-level", "nested", or "none".

See Also:

Client.frameType - MDN, frameType - Service Workers

id

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

The id read-only property of the Client interface returns the universally unique identifier of the Client object.

See Also:

Client.id - MDN, id - Service Workers

type

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

The type read-only property of the Client interface indicates the type of client the service worker is controlling.

See Also:

Client.type - MDN, type - Service Workers

url

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

The url read-only property of the Client interface returns the URL of the current service worker client.

See Also:

Client.url - MDN, url - Service Workers

postMessage

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

The postMessage() method of the Client interface allows a service worker to send a message to a client (a Window, Worker, or SharedWorker). The message is received in the "message" event on navigator.serviceWorker.

See Also:

Client.postMessage - MDN, postMessage() - Service Workers

postMessage

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

The postMessage() method of the Client interface allows a service worker to send a message to a client (a Window, Worker, or SharedWorker). The message is received in the "message" event on navigator.serviceWorker.

See Also:

Client.postMessage - MDN, postMessage() - Service Workers

postMessage

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

The postMessage() method of the Client interface allows a service worker to send a message to a client (a Window, Worker, or SharedWorker). The message is received in the "message" event on navigator.serviceWorker.

See Also:

Client.postMessage - MDN, postMessage() - Service Workers

postMessage

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

The postMessage() method of the Client interface allows a service worker to send a message to a client (a Window, Worker, or SharedWorker). The message is received in the "message" event on navigator.serviceWorker.

See Also:

Client.postMessage - MDN, postMessage() - Service Workers