Kotlin Wrappers API Reference

kotlin-web/web.broadcast/BroadcastChannel

BroadcastChannel

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

The BroadcastChannel interface represents a named channel that any browsing context of a given origin can subscribe to.

Constructors

BroadcastChannel

constructor(name: String)

Properties

val name: String

The name read-only property of the BroadcastChannel interface returns a string, which uniquely identifies the given channel with its name.

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

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

Functions

fun close()

The close() method of the BroadcastChannel interface terminates the connection to the underlying channel, allowing the object to be garbage collected.

fun dispatchEvent(event: Event): Boolean

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.

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