diff options
Diffstat (limited to 'dom/webidl/ExtensionPort.webidl')
-rw-r--r-- | dom/webidl/ExtensionPort.webidl | 48 |
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 = ""; +}; |