kotlin-web/web.broadcast/BroadcastChannel

BroadcastChannel

open class BroadcastChannel(val name: String) : EventTarget, JsCloseable(source)

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, except the object that sent the message.

MDN Reference

Constructors

BroadcastChannel

constructor(name: String)

Properties

name

val name: String

The name read-only property of the BroadcastChannel interface returns a string, 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.

onmessage

var onmessage: EventHandler<MessageEvent<*>, BroadcastChannel, BroadcastChannel>?

MDN Reference

onmessageerror

var onmessageerror: EventHandler<MessageEvent<*>, BroadcastChannel, BroadcastChannel>?

MDN Reference

Functions

addEventListener

fun <E : Event> EventTargetLike.addEventListener(type: EventType<E>, handler: (E) -> Unit, options: AddEventListenerOptions? = undefined)

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

open override fun close()

The close() method of the BroadcastChannel interface 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.

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

postMessage

fun postMessage(message: String)

fun postMessage(message: JsAny?)

The postMessage() method of the BroadcastChannel interface 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.

removeEventListener

fun <E : Event> EventTargetLike.removeEventListener(type: EventType<E>, handler: (E) -> Unit, options: EventListenerOptions? = undefined)

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions? = definedExternally): Observable<T>

MDN Reference