dom/webidl/ExtensionAlarms.webidl

   1 /*
   2  *  THIS IS AN AUTOGENERATED FILE.  DO NOT EDIT
   3  *
   4  *  The content of this file has been generated based on the WebExtensions API
   5  *  JSONSchema using the following command:
   6  *
   7  *  export SCRIPT_DIR="toolkit/components/extensions/webidl-api"
   8  *  mach python $SCRIPT_DIR/GenerateWebIDLBindings.py -- alarms
   9  *
  10  *  More info about generating webidl API bindings for WebExtensions API at:
  11  *
  12  *  https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/webidl_bindings.html
  13  *
  14  *  A short summary of the special setup used by these WebIDL files (meant to aid
  15  *  webidl peers reviews and sign-offs) is available in the following section:
  16  *
  17  *  https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/webidl_bindings.html#review-process-on-changes-to-webidl-definitions
  18  */
  19
  20 /* This Source Code Form is subject to the terms of the Mozilla Public
  21  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
  22  * You can obtain one at http://mozilla.org/MPL/2.0/.
  23  *
  24  * You are granted a license to use, reproduce and create derivative works of
  25  * this document.
  26  */
  27
  28 // WebIDL definition for the "alarms" WebExtensions API
  29 [Exposed=(ServiceWorker), LegacyNoInterfaceObject]
  30 interface ExtensionAlarms {
  31   // API methods.
  32
  33   [Throws, WebExtensionStub="NoReturn"]
  34   undefined create(DOMString name, any alarmInfo);
  35   [Throws, WebExtensionStub="NoReturn"]
  36   undefined create(any alarmInfo);
  37
  38   [Throws, WebExtensionStub="Async"]
  39   any get(DOMString name, optional Function callback);
  40   [Throws, WebExtensionStub="Async"]
  41   any get(optional Function callback);
  42
  43   [Throws, WebExtensionStub="Async"]
  44   any getAll(optional Function callback);
  45
  46   [Throws, WebExtensionStub="Async"]
  47   any clear(DOMString name, optional Function callback);
  48   [Throws, WebExtensionStub="Async"]
  49   any clear(optional Function callback);
  50
  51   [Throws, WebExtensionStub="Async"]
  52   any clearAll(optional Function callback);
  53
  54   // API events.
  55
  56   [Replaceable, SameObject]
  57   readonly attribute ExtensionEventManager onAlarm;
  58 };