dom/interfaces/apps/nsIInterAppCommService.idl

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/dom/interfaces/apps/nsIInterAppCommService.idl	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,37 @@
     1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this file,
     1.6 + * You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.7 +
     1.8 +#include "domstubs.idl"
     1.9 +
    1.10 +interface nsIURI;
    1.11 +
    1.12 +/**
    1.13 + * Implemented by the contract id @mozilla.org/inter-app-communication-service;1
    1.14 + *
    1.15 + * This interface contains helpers for Inter-App Communication API [1] related
    1.16 + * purposes. A singleton service of this interface will be instantiated during
    1.17 + * the system boot-up, which plays the role of the central service receiving
    1.18 + * messages from and interacting with the content processes.
    1.19 + *
    1.20 + * [1] https://wiki.mozilla.org/WebAPI/Inter_App_Communication_Alt_proposal
    1.21 + */
    1.22 +[scriptable, uuid(b3d711a4-c6a4-11e3-8fd3-738e7fbcb6d6)]
    1.23 +interface nsIInterAppCommService : nsISupports
    1.24 +{
    1.25 +  /*
    1.26 +   * Registration of a page that wants to be connected to other apps through
    1.27 +   * the Inter-App Communication API.
    1.28 +   *
    1.29 +   * @param keyword        The connection's keyword.
    1.30 +   * @param handlerPageURI The URI of the handler's page.
    1.31 +   * @param manifestURI    The webapp's manifest URI.
    1.32 +   * @param description    The connection's description.
    1.33 +   * @param rules          The connection's rules.
    1.34 +   */
    1.35 +  void registerConnection(in DOMString      keyword,
    1.36 +                          in nsIURI         handlerPageURI,
    1.37 +                          in nsIURI         manifestURI,
    1.38 +                          in DOMString      description,
    1.39 +                          in jsval          rules);
    1.40 +};

mercurial