Kotlin Wrappers API Reference

kotlin-web/web.broadcast/BroadcastChannel

BroadcastChannel

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

Constructors

BroadcastChannel

constructor(name: String)

Properties

messageErrorEvent

val messageErrorEvent: EventInstance<MessageEvent<JsAny?>, BroadcastChannel, BroadcastChannel>

val messageEvent: EventInstance<MessageEvent<JsAny?>, BroadcastChannel, BroadcastChannel>

val name: String

Returns the channel name (as passed to the constructor).

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

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

Functions

fun close()

Closes the BroadcastChannel object, opening it up to garbage collection.

fun dispatchEvent(event: Event): Boolean

fun postMessage(message: JsAny?)

Sends the given message to other BroadcastChannel objects set up for this channel. Messages can be structured objects, e.g. nested objects and arrays.