gecko-dev/dom/webidl/MessageEvent.webidl

66 lines
2.3 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* For more information on this interface, please see
* https://html.spec.whatwg.org/#messageevent
*/
[Exposed=(Window,Worker)]
interface MessageEvent : Event {
constructor(DOMString type, optional MessageEventInit eventInitDict = {});
/**
* Custom data associated with this event.
*/
[GetterThrows]
readonly attribute any data;
/**
* The origin of the site from which this event originated, which is the
* scheme, ":", and if the URI has a host, "//" followed by the
* host, and if the port is not the default for the given scheme,
* ":" followed by that port. This value does not have a trailing slash.
*/
readonly attribute USVString origin;
/**
* The last event ID string of the event source, for server-sent DOM events; this
* value is the empty string for cross-origin messaging.
*/
readonly attribute DOMString lastEventId;
/**
* The window or port which originated this event.
*/
readonly attribute MessageEventSource? source;
[Pure, Cached, Frozen]
readonly attribute sequence<MessagePort> ports;
/**
* Initializes this event with the given data, in a manner analogous to
* the similarly-named method on the Event interface, also setting the
* data, origin, source, and lastEventId attributes of this appropriately.
*/
undefined initMessageEvent(DOMString type,
optional boolean bubbles = false,
optional boolean cancelable = false,
optional any data = null,
optional DOMString origin = "",
optional DOMString lastEventId = "",
optional MessageEventSource? source = null,
optional sequence<MessagePort> ports = []);
};
dictionary MessageEventInit : EventInit {
any data = null;
DOMString origin = "";
DOMString lastEventId = "";
MessageEventSource? source = null;
sequence<MessagePort> ports = [];
};
typedef (WindowProxy or MessagePort or ServiceWorker) MessageEventSource;