ExtensionSetting.webidl (1641B)
1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ 2 /* This Source Code Form is subject to the terms of the Mozilla Public 3 * License, v. 2.0. If a copy of the MPL was not distributed with this file, 4 * You can obtain one at http://mozilla.org/MPL/2.0/. 5 * 6 * You are granted a license to use, reproduce and create derivative works of 7 * this document. 8 * 9 * This IDL file is related to the WebExtensions API object. 10 * 11 * The ExtensionSetting interface is used by the API namespace that expose 12 * settings API sub-namespaces (in particular browserSettings, proxy, 13 * captivePortal and privacy WebExtensions APIs). 14 * 15 * More info about generating webidl API bindings for WebExtensions API at: 16 * 17 * https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/webidl_bindings.html 18 * 19 * A short summary of the special setup used by these WebIDL files (meant to aid 20 * webidl peers reviews and sign-offs) is available in the following section: 21 * 22 * https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/webidl_bindings.html#review-process-on-changes-to-webidl-definitions 23 */ 24 25 [Exposed=(ServiceWorker), LegacyNoInterfaceObject] 26 interface ExtensionSetting { 27 // API methods. 28 29 [Throws, WebExtensionStub="Async"] 30 any get(object details, optional Function callback); 31 32 [Throws, WebExtensionStub="Async"] 33 any set(object details, optional Function callback); 34 35 [Throws, WebExtensionStub="Async"] 36 any clear(object details, optional Function callback); 37 38 // API events. 39 40 [Replaceable, SameObject] 41 readonly attribute ExtensionEventManager onChange; 42 };