gecko/dom/interfaces/base/nsIServiceWorkerManager.idl

/* -*- 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/. */

#include "domstubs.idl"

interface nsIDocument;
interface nsIURI;

[uuid(c7132f91-c46c-4e01-b75a-43babb254d93)]
interface nsIServiceWorkerManager : nsISupports
{
  /**
   * Registers a ServiceWorker with script loaded from `aScriptURI` to act as
   * the ServiceWorker for aScope.  Requires a valid entry settings object on
   * the stack. This means you must call this from content code 'within'
   * a window.
   *
   * Returns a Promise.
   */
  nsISupports register(in DOMString aScope, in DOMString aScriptURI);

  /**
   * Unregister an existing ServiceWorker registration for `aScope`.  Requires
   * a valid entry settings object on the stack. This means you must call this
   * from content code 'within' a window.
   *
   * Returns a Promise.
   */
  nsISupports unregister(in DOMString aScope);

  // Returns a Promise
  nsISupports getRegistrations(in nsIDOMWindow aWindow);

  // Returns a Promise
  nsISupports getRegistration(in nsIDOMWindow aWindow, in DOMString aScope);

  // aTarget MUST be a ServiceWorkerRegistration.
  [noscript] void AddRegistrationEventListener(in nsIURI aPageURI, in nsIDOMEventTarget aTarget);
  [noscript] void RemoveRegistrationEventListener(in nsIURI aPageURI, in nsIDOMEventTarget aTarget);

  /**
   * Call this to request that document `aDoc` be controlled by a ServiceWorker
   * if a registration exists for it's scope.
   *
   * This MUST only be called once per document!
   */
  [notxpcom,nostdcall] void MaybeStartControlling(in nsIDocument aDoc);

  /**
   * Documents that have called MaybeStartControlling() should call this when
   * they are destroyed. This function may be called multiple times, and is
   * idempotent.
   */
  [notxpcom,nostdcall] void MaybeStopControlling(in nsIDocument aDoc);

  // Returns a ServiceWorker
  [noscript] nsISupports GetInstalling(in nsIDOMWindow aWindow);
  [noscript] nsISupports GetWaiting(in nsIDOMWindow aWindow);
  [noscript] nsISupports GetActive(in nsIDOMWindow aWindow);
  [noscript] nsISupports GetDocumentController(in nsIDOMWindow aWindow);

  // Testing
  DOMString getScopeForUrl(in DOMString path);
};

%{ C++
#define SERVICEWORKERMANAGER_CONTRACTID "@mozilla.org/serviceworkers/manager;1"
%}