summaryrefslogtreecommitdiffstats
path: root/dom/webidl/ExtensionPort.webidl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /dom/webidl/ExtensionPort.webidl
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/webidl/ExtensionPort.webidl')
-rw-r--r--dom/webidl/ExtensionPort.webidl48
1 files changed, 48 insertions, 0 deletions
diff --git a/dom/webidl/ExtensionPort.webidl b/dom/webidl/ExtensionPort.webidl
new file mode 100644
index 0000000000..35fb60dea7
--- /dev/null
+++ b/dom/webidl/ExtensionPort.webidl
@@ -0,0 +1,48 @@
+/* -*- 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/.
+ *
+ * You are granted a license to use, reproduce and create derivative works of
+ * this document.
+ *
+ * This IDL file is related to the WebExtensions browser.runtime's Port.
+ *
+ * More info about generating webidl API bindings for WebExtensions API at:
+ *
+ * https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/webidl_bindings.html
+ *
+ * A short summary of the special setup used by these WebIDL files (meant to aid
+ * webidl peers reviews and sign-offs) is available in the following section:
+ *
+ * https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/webidl_bindings.html#review-process-on-changes-to-webidl-definitions
+ */
+
+[Exposed=(ServiceWorker), LegacyNoInterfaceObject]
+interface ExtensionPort {
+ [Replaceable]
+ readonly attribute DOMString name;
+ [Replaceable]
+ readonly attribute any sender;
+ [Replaceable]
+ readonly attribute any error;
+
+ [Throws, WebExtensionStub="NoReturn"]
+ undefined disconnect();
+ [Throws, WebExtensionStub="NoReturn"]
+ undefined postMessage(any message);
+
+ [Replaceable, SameObject]
+ readonly attribute ExtensionEventManager onDisconnect;
+ [Replaceable, SameObject]
+ readonly attribute ExtensionEventManager onMessage;
+};
+
+// Dictionary used by ExtensionAPIRequestForwarder and ExtensionCallabck to receive from the
+// mozIExtensionAPIRequestHandler an internal description of a runtime.Port (and then used in
+// the webidl implementation to create an ExtensionPort instance).
+[GenerateInit]
+dictionary ExtensionPortDescriptor {
+ required DOMString portId;
+ DOMString name = "";
+};