toolkit/components/remote/nsIRemoteService.idl

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

     1 /* This Source Code Form is subject to the terms of the Mozilla Public
     2  * License, v. 2.0. If a copy of the MPL was not distributed with this
     3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     5 #include "nsISupports.idl"
     7 interface nsIDOMWindow;
     9 /**
    10  * Start and stop the remote service (xremote/phremote), and register
    11  * windows with the service for backwards compatibility with old xremote
    12  * clients.
    13  *
    14  * @status FLUID This interface is not frozen and is not intended for embedders
    15  *               who want a frozen API. If you are an embedder and need this
    16  *               functionality, contact Benjamin Smedberg about the possibility
    17  *               of freezing the functionality you need.
    18  */
    20 [scriptable, uuid(a2240f6a-f1e4-4548-9e1a-6f3bc9b2426c)]
    21 interface nsIRemoteService : nsISupports
    22 {
    23   /**
    24    * Start the remote service. This should not be done until app startup
    25    * appears to have been successful.
    26    *
    27    * @param appName     (Required) Sets a window property identifying the
    28    *                    application.
    29    * @param profileName (May be null) Sets a window property identifying the
    30    *                    profile name.
    31    */
    32   void startup(in string appName, in string profileName);
    34   /**
    35    * Register a XUL window with the xremote service. The window will be
    36    * configured to accept incoming remote requests. If this method is called
    37    * before startup(), the registration will happen once startup() is called.
    38    */
    39   void registerWindow(in nsIDOMWindow aWindow);
    41   /**
    42    * Stop the remote service from accepting additional requests.
    43    */
    44   void shutdown();
    45 };

mercurial