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

AT_TARGET

val AT_TARGET: EventPhase

bubbles

val bubbles: Boolean

BUBBLING_PHASE

val BUBBLING_PHASE: EventPhase

cancelable

val cancelable: Boolean

CAPTURING_PHASE

val CAPTURING_PHASE: EventPhase

composed

val composed: Boolean

currentTarget

val currentTarget: EventTarget?

data

val data: JsAny?

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

defaultPrevented

val defaultPrevented: Boolean

eventPhase

val eventPhase: EventPhase

isTrusted

val isTrusted: Boolean

lastEventId

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.

NONE

val NONE: EventPhase

origin

val origin: String

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

ports

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

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

val target: EventTarget?

timeStamp

val timeStamp: DOMHighResTimeStamp

type

open override val type: EventType<ExtendableMessageEvent>

Functions

composedPath

fun composedPath(): ReadonlyArray<EventTarget>

preventDefault

fun preventDefault()

stopImmediatePropagation

fun stopImmediatePropagation()

stopPropagation

fun stopPropagation()

waitUntil

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: CoroutineScope.() -> Unit)

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