toolkit/components/remote/nsIRemoteService.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is mozilla.org code.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Christopher Blizzard <blizzard@mozilla.org>.
  18  * Portions created by the Initial Developer are Copyright (C) 2001
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Benjamin Smedberg <benjamin@smedbergs.us>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface nsIDOMWindow;
  41
  42 /**
  43  * Start and stop the remote service (xremote/phremote), and register
  44  * windows with the service for backwards compatibility with old xremote
  45  * clients.
  46  *
  47  * @status FLUID This interface is not frozen and is not intended for embedders
  48  *               who want a frozen API. If you are an embedder and need this
  49  *               functionality, contact Benjamin Smedberg about the possibility
  50  *               of freezing the functionality you need.
  51  */
  52
  53 [scriptable, uuid(a2240f6a-f1e4-4548-9e1a-6f3bc9b2426c)]
  54 interface nsIRemoteService : nsISupports
  55 {
  56   /**
  57    * Start the remote service. This should not be done until app startup
  58    * appears to have been successful.
  59    *
  60    * @param appName     (Required) Sets a window property identifying the
  61    *                    application.
  62    * @param profileName (May be null) Sets a window property identifying the
  63    *                    profile name.
  64    */
  65   void startup(in string appName, in string profileName);
  66
  67   /**
  68    * Register a XUL window with the xremote service. The window will be
  69    * configured to accept incoming remote requests. If this method is called
  70    * before startup(), the registration will happen once startup() is called.
  71    */
  72   void registerWindow(in nsIDOMWindow aWindow);
  73
  74   /**
  75    * Stop the remote service from accepting additional requests.
  76    */
  77   void shutdown();
  78 };