summaryrefslogtreecommitdiffstats
path: root/dom/webidl/MessageEvent.webidl
diff options
context:
space:
mode:
Diffstat (limited to 'dom/webidl/MessageEvent.webidl')
-rw-r--r--dom/webidl/MessageEvent.webidl65
1 files changed, 65 insertions, 0 deletions
diff --git a/dom/webidl/MessageEvent.webidl b/dom/webidl/MessageEvent.webidl
new file mode 100644
index 0000000000..e4f4ceac60
--- /dev/null
+++ b/dom/webidl/MessageEvent.webidl
@@ -0,0 +1,65 @@
+/* -*- 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,AudioWorklet), ProbablyShortLivingWrapper]
+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;