dom/webidl/ServiceWorkerContainer.webidl

   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  * The origin of this IDL file is
   7  * https://w3c.github.io/ServiceWorker/#serviceworkercontainer
   8  *
   9  */
  10
  11 [Func="ServiceWorkersEnabled",
  12  Exposed=Window]
  13 interface ServiceWorkerContainer : EventTarget {
  14   // FIXME(nsm):
  15   // https://github.com/slightlyoff/ServiceWorker/issues/198
  16   // and discussion at https://etherpad.mozilla.org/serviceworker07apr
  17   readonly attribute ServiceWorker? controller;
  18
  19   [Throws]
  20   readonly attribute Promise<ServiceWorkerRegistration> ready;
  21
  22   [NewObject, NeedsCallerType]
  23   Promise<ServiceWorkerRegistration> register(USVString scriptURL,
  24                                               optional RegistrationOptions options = {});
  25
  26   [NewObject]
  27   Promise<(ServiceWorkerRegistration or undefined)> getRegistration(optional USVString documentURL = "");
  28
  29   [NewObject]
  30   Promise<sequence<ServiceWorkerRegistration>> getRegistrations();
  31
  32   undefined startMessages();
  33
  34   attribute EventHandler oncontrollerchange;
  35   attribute EventHandler onmessage;
  36   attribute EventHandler onmessageerror;
  37 };
  38
  39 // Testing only.
  40 partial interface ServiceWorkerContainer {
  41   [Throws,Pref="dom.serviceWorkers.testing.enabled"]
  42   DOMString getScopeForUrl(DOMString url);
  43 };
  44
  45 dictionary RegistrationOptions {
  46   USVString scope;
  47   ServiceWorkerUpdateViaCache updateViaCache = "imports";
  48 };