kotlin-browser/web.serviceworker/ExtendableMessageEvent

ExtendableMessageEvent

open class ExtendableMessageEvent(val type: EventType<ExtendableMessageEvent>, init: ExtendableMessageEventInit = definedExternally) : ExtendableEvent(source)

The ExtendableMessageEvent interface of the Service Worker API represents the event object of a message event fired on a service worker (when a message is received on the ServiceWorkerGlobalScope from another context) — extends the lifetime of such events.

MDN Reference

Constructors

constructor(type: EventType<ExtendableMessageEvent>, init: ExtendableMessageEventInit = definedExternally)

Types

Companion

object Companion

Properties

bubbles

external val bubbles: Boolean

cancelable

external val cancelable: Boolean

composed

external val composed: Boolean

currentTarget

external val currentTarget: EventTarget?

data

external val data: JsAny?

The data read-only property of the ExtendableMessageEvent interface returns the event's data. It can be any data type.

defaultPrevented

external val defaultPrevented: Boolean

eventPhase

external val eventPhase: EventPhase

isTrusted

external val isTrusted: Boolean

lastEventId

external val lastEventId: String

The lastEventID read-only property of the ExtendableMessageEvent interface represents, in server-sent events, the last event ID of the event source. This is an empty string.

origin

external val origin: String

The origin read-only property of the ExtendableMessageEvent interface returns the origin of the Client that sent the message.

ports

external val ports: ReadonlyArray<MessagePort>

The ports read-only property of the ExtendableMessageEvent interface returns the array containing the MessagePort objects representing the ports of the associated message channel (the channel the message is being sent through.)

source

external val source: JsAny?

The source read-only property of the ExtendableMessageEvent interface returns a reference to the Client object from which the message was sent.

target

external val target: EventTarget?

timeStamp

external val timeStamp: DOMHighResTimeStamp

type

open external override val type: EventType<ExtendableMessageEvent>

Functions

composedPath

external fun composedPath(): ReadonlyArray<EventTarget>

preventDefault

external fun preventDefault()

stopImmediatePropagation

external fun stopImmediatePropagation()

stopPropagation

external fun stopPropagation()

waitUntil

external fun waitUntil(f: Promise<*>)

The ExtendableEvent.waitUntil() method tells the event dispatcher that work is ongoing. It can also be used to detect whether that work was successful. In service workers, waitUntil() tells the browser that work is ongoing until the promise settles, and it shouldn't terminate the service worker if it wants that work to complete.

waitUntil

fun ExtendableEvent.waitUntil(block: suspend CoroutineScope.() -> Unit)

The ExtendableEvent.waitUntil() method tells the event dispatcher that work is ongoing.