summaryrefslogtreecommitdiffstats
path: root/dom/webidl/ExtensionSetting.webidl
diff options
context:
space:
mode:
Diffstat (limited to 'dom/webidl/ExtensionSetting.webidl')
-rw-r--r--dom/webidl/ExtensionSetting.webidl42
1 files changed, 42 insertions, 0 deletions
diff --git a/dom/webidl/ExtensionSetting.webidl b/dom/webidl/ExtensionSetting.webidl
new file mode 100644
index 0000000000..578feb17ff
--- /dev/null
+++ b/dom/webidl/ExtensionSetting.webidl
@@ -0,0 +1,42 @@
+/* -*- 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 API object.
+ *
+ * The ExtensionSetting interface is used by the API namespace that expose
+ * settings API sub-namespaces (in particular browserSettings, proxy,
+ * captivePortal and privacy WebExtensions APIs).
+ *
+ * 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 ExtensionSetting {
+ // API methods.
+
+ [Throws, WebExtensionStub="Async"]
+ any get(object details, optional Function callback);
+
+ [Throws, WebExtensionStub="Async"]
+ any set(object details, optional Function callback);
+
+ [Throws, WebExtensionStub="Async"]
+ any clear(object details, optional Function callback);
+
+ // API events.
+
+ [Replaceable, SameObject]
+ readonly attribute ExtensionEventManager onChange;
+};