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