akasha

Class BroadcastChannel

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.BroadcastChannel

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

The BroadcastChannel interface represents a named channel that any browsing context of a given origin can subscribe to. It allows communication between different documents (in different windows, tabs, frames or iframes) of the same origin. Messages are broadcasted via a message event fired at all BroadcastChannel objects listening to the channel.

See Also:

BroadcastChannel - MDN, (HTML) # broadcasting-to-other-browsing-contexts

Field Summary

Fields

Modifier and Type	Field and Description
MessageEventHandler	onmessage The BroadcastChannel.onmessage event handler is a property that specifies the function to execute when a message event, of type MessageEvent, is received by this BroadcastChannel.
MessageEventHandler	onmessageerror The onmessageerror event handler of the BroadcastChannel interface is an EventListener, called whenever an MessageEvent of type messageerror is fired on the BroadcastChannel instance — that is, when it receives a message that cannot be deserialized.

Constructor Summary

Constructors

Constructor and Description
BroadcastChannel(java.lang.String name) The BroadcastChannel() constructor creates a new BroadcastChannel and connects it to the underlying channel.

Method Summary

Modifier and Type	Method and Description
void	addMessageerrorListener(MessageEventListener callback)
void	addMessageerrorListener(MessageEventListener callback, AddEventListenerOptions options)
void	addMessageerrorListener(MessageEventListener callback, boolean useCapture)
void	addMessageListener(MessageEventListener callback)
void	addMessageListener(MessageEventListener callback, AddEventListenerOptions options)
void	addMessageListener(MessageEventListener callback, boolean useCapture)
void	close() The BroadcastChannel.close() terminates the connection to the underlying channel, allowing the object to be garbage collected.
java.lang.String	name() The read-only BroadcastChannel.name property returns a DOMString, which uniquely identifies the given channel with its name.
void	postMessage(java.lang.Object message) The BroadcastChannel.postMessage() sends a message, which can be of any kind of Object, to each listener in any browsing context with the same origin.
void	removeMessageerrorListener(MessageEventListener callback)
void	removeMessageerrorListener(MessageEventListener callback, boolean useCapture)
void	removeMessageerrorListener(MessageEventListener callback, EventListenerOptions options)
void	removeMessageListener(MessageEventListener callback)
void	removeMessageListener(MessageEventListener callback, boolean useCapture)
void	removeMessageListener(MessageEventListener callback, EventListenerOptions options)

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

onmessage

@Nullable
public MessageEventHandler onmessage

The BroadcastChannel.onmessage event handler is a property that specifies the function to execute when a message event, of type MessageEvent, is received by this BroadcastChannel. Such an event is sent by the browser with a message broadcasted to the channel.

See Also:

BroadcastChannel.onmessage - MDN, BroadcastChannel.onmessage - HTML Living Standard

onmessageerror

@Nullable
public MessageEventHandler onmessageerror

The onmessageerror event handler of the BroadcastChannel interface is an EventListener, called whenever an MessageEvent of type messageerror is fired on the BroadcastChannel instance — that is, when it receives a message that cannot be deserialized.

See Also:

BroadcastChannel.onmessageerror - MDN, onmessageerror - HTML Living Standard

Constructor Detail

BroadcastChannel

public BroadcastChannel(@Nonnull
                        java.lang.String name)

The BroadcastChannel() constructor creates a new BroadcastChannel and connects it to the underlying channel.

See Also:

BroadcastChannel.BroadcastChannel - MDN, BroadcastChannel() - HTML Living Standard

Method Detail

name

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

The read-only BroadcastChannel.name property returns a DOMString, which uniquely identifies the given channel with its name. This name is passed to the BroadcastChannel() constructor at creation time and is therefore read-only.

See Also:

BroadcastChannel.name - MDN, BroadcastChannel.name - HTML Living Standard

close

public void close()

The BroadcastChannel.close() terminates the connection to the underlying channel, allowing the object to be garbage collected. This is a necessary step to perform as there is no other way for a browser to know that this channel is not needed anymore.

See Also:

BroadcastChannel.close - MDN, BroadcastChannel.close() - HTML Living Standard

postMessage

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

The BroadcastChannel.postMessage() sends a message, which can be of any kind of Object, to each listener in any browsing context with the same origin. The message is transmitted as a message event targeted at each BroadcastChannel bound to the channel.

See Also:

BroadcastChannel.postMessage - MDN, BroadcastChannel.postmessage() - HTML Living Standard

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)

addMessageerrorListener

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

addMessageerrorListener

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

addMessageerrorListener

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

removeMessageerrorListener

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

removeMessageerrorListener

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

removeMessageerrorListener

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