1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/toolkit/components/remote/nsIRemoteService.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,45 @@
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
1.6 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.7 +
1.8 +#include "nsISupports.idl"
1.9 +
1.10 +interface nsIDOMWindow;
1.11 +
1.12 +/**
1.13 + * Start and stop the remote service (xremote/phremote), and register
1.14 + * windows with the service for backwards compatibility with old xremote
1.15 + * clients.
1.16 + *
1.17 + * @status FLUID This interface is not frozen and is not intended for embedders
1.18 + * who want a frozen API. If you are an embedder and need this
1.19 + * functionality, contact Benjamin Smedberg about the possibility
1.20 + * of freezing the functionality you need.
1.21 + */
1.22 +
1.23 +[scriptable, uuid(a2240f6a-f1e4-4548-9e1a-6f3bc9b2426c)]
1.24 +interface nsIRemoteService : nsISupports
1.25 +{
1.26 + /**
1.27 + * Start the remote service. This should not be done until app startup
1.28 + * appears to have been successful.
1.29 + *
1.30 + * @param appName (Required) Sets a window property identifying the
1.31 + * application.
1.32 + * @param profileName (May be null) Sets a window property identifying the
1.33 + * profile name.
1.34 + */
1.35 + void startup(in string appName, in string profileName);
1.36 +
1.37 + /**
1.38 + * Register a XUL window with the xremote service. The window will be
1.39 + * configured to accept incoming remote requests. If this method is called
1.40 + * before startup(), the registration will happen once startup() is called.
1.41 + */
1.42 + void registerWindow(in nsIDOMWindow aWindow);
1.43 +
1.44 + /**
1.45 + * Stop the remote service from accepting additional requests.
1.46 + */
1.47 + void shutdown();
1.48 +};
