Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIRemoteService Interface Reference

Start and stop the remote service (xremote/phremote), and register windows with the service for backwards compatibility with old xremote clients. More...

import "nsIRemoteService.idl";

Inheritance diagram for nsIRemoteService:
Inheritance graph
[legend]
Collaboration diagram for nsIRemoteService:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void startup (in string appName, in string profileName)
 Start the remote service.
void registerWindow (in nsIDOMWindow aWindow)
 Register a XUL window with the xremote service.
void shutdown ()
 Stop the remote service from accepting additional requests.

Detailed Description

Start and stop the remote service (xremote/phremote), and register windows with the service for backwards compatibility with old xremote clients.

FLUID This interface is not frozen and is not intended for embedders who want a frozen API. If you are an embedder and need this functionality, contact Benjamin Smedberg about the possibility of freezing the functionality you need.

Definition at line 54 of file nsIRemoteService.idl.


Member Function Documentation

Register a XUL window with the xremote service.

The window will be configured to accept incoming remote requests. If this method is called before startup(), the registration will happen once startup() is called.

Stop the remote service from accepting additional requests.

void nsIRemoteService::startup ( in string  appName,
in string  profileName 
)

Start the remote service.

This should not be done until app startup appears to have been successful.

Parameters:
appName(Required) Sets a window property identifying the application.
profileName(May be null) Sets a window property identifying the profile name.

The documentation for this interface was generated from the following file: