MessageEvent class

The interface represents a message received by a target object. This is used to represent messages in:

Server-sent events (see EventSource.onmessage). Web sockets (see the onmessage property of the WebSocket interface). Cross-document messaging (see Window.postMessage() and Window.onmessage). Channel messaging (see MessagePort.postMessage() and MessagePort.onmessage). Cross-worker/document messaging (see the above two entries, but also Worker.postMessage(), Worker.onmessage, ServiceWorkerGlobalScope.onmessage, etc.) Broadcast channels (see Broadcastchannel.postMessage()) and BroadcastChannel.onmessage). WebRTC data channels (see RTCDataChannel.onmessage).

The action triggered by this event is defined in a function set as the event handler for the relevant message event (e.g. using an onmessage handler as listed above). Note: This feature is available in Web Workers

Event

MessageEvent

Implemented types
Available extensions
Annotations
  • @JS()
  • @staticInterop

Constructors

MessageEvent(String type, [MessageEventInit? eventInitDict])
factory

Properties

bubbles bool

Available on Event, provided by the PropsEvent extension

no setter
cancelable bool

Available on Event, provided by the PropsEvent extension

no setter
cancelBubble bool

Available on Event, provided by the PropsEvent extension

getter/setter pair
composed bool

Available on Event, provided by the PropsEvent extension

no setter
currentTarget EventTarget?

Available on Event, provided by the PropsEvent extension

no setter
data → dynamic

Available on MessageEvent, provided by the PropsMessageEvent extension

no setter
defaultPrevented bool

Available on Event, provided by the PropsEvent extension

no setter
eventPhase int

Available on Event, provided by the PropsEvent extension

no setter
hashCode int
The hash code for this object.
no setterinherited
isTrusted bool

Available on Event, provided by the PropsEvent extension

no setter
lastEventId String

Available on MessageEvent, provided by the PropsMessageEvent extension

no setter
origin String

Available on MessageEvent, provided by the PropsMessageEvent extension

no setter
ports Iterable<MessagePort>

Available on MessageEvent, provided by the PropsMessageEvent extension

no setter
returnValue ↔ dynamic

Available on Event, provided by the PropsEvent extension

getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
source → dynamic

Available on MessageEvent, provided by the PropsMessageEvent extension

no setter
srcElement EventTarget?

Available on Event, provided by the PropsEvent extension

no setter
target EventTarget?

Available on Event, provided by the PropsEvent extension

no setter
timeStamp double

Available on Event, provided by the PropsEvent extension

no setter
type String

Available on Event, provided by the PropsEvent extension

no setter

Methods

composedPath() Iterable<EventTarget>

Available on Event, provided by the PropsEvent extension

initEvent(String type, [bool? bubbles = false, bool? cancelable = false]) → void

Available on Event, provided by the PropsEvent extension

initMessageEvent(String type, [bool? bubbles = false, bool? cancelable = false, dynamic data, String? origin = '', String? lastEventId = '', dynamic source, Iterable<MessagePort>? ports = const []]) → void

Available on MessageEvent, provided by the PropsMessageEvent extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
preventDefault() → void

Available on Event, provided by the PropsEvent extension

stopImmediatePropagation() → void

Available on Event, provided by the PropsEvent extension

stopPropagation() → void

Available on Event, provided by the PropsEvent extension

toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited