nsIRemoteService

IID:a2240f6a-f1e4-4548-9e1a-6f3bc9b2426c
Inherits From:nsISupports
Status: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.

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

This interface is intended to be used as a service. To create an object implementing this interface:

var obj = Components.classes["@mozilla.org/toolkit/remote-service;1"].
            getService(Components.interfaces.nsIRemoteService);

This interface is implemented by the following components:


Methods

void registerWindow ( nsIDOMWindow window ) void shutdown ( ) void startup ( char* appName , char* profileName )

void registerWindow ( nsIDOMWindow window )

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.

Arguments:
window

void shutdown ( )

Stop the remote service from accepting additional requests.


void startup ( char* appName , char* profileName )

Start the remote service. This should not be done until app startup appears to have been successful.

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

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com