toolkit/components/remote/nsIRemoteService.idl

   1 /* -*- Mode: IDL; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 [scriptable, builtinclass, uuid(f4ef671b-838c-48fd-bc44-0f6cf63bce91)]
   9 interface nsIRemoteService : nsISupports
  10 {
  11   /**
  12     * Sends command line arguments to another running instance.
  13     * Note that the other instance must be on the same update channel. The
  14     * profile argument should be the full path to the root profile folder. The
  15     * other instance must also have not disabled the remoting service (e.g. with
  16     * -no-remote on the command line).
  17     *
  18     * @param aProfile
  19     *        The profile the running instance is using.
  20     * @param aArgs
  21     *        The command line arguments to send. Don't include the initial
  22     *        binary path argument.
  23     * @param aRaise
  24     *        Whether the target instance's window should be brought to the
  25     *        foreground. The actual effect of this is platform-dependent; see
  26     *        comments in platform-specific implementations for further
  27     *        information.
  28     * @throws NS_ERROR_NOT_AVAILABLE if no running instance was found.
  29     */
  30   void sendCommandLine(in ACString aProfile, in Array<ACString> aArgs, [optional] in boolean aRaise);
  31 };