nsIAppStartup

Implemented by: @mozilla.org/toolkit/app-startup;1. To use the service:

var appStartup = Components.classes["@mozilla.org/toolkit/app-startup;1"]
                 .getService(Components.interfaces.nsIAppStartup);

Method overview

Attributes

Constants

The following flags may be passed as the aMode parameter to the quit() method. One and only one of the "Quit" flags must be specified. The eRestart flag may be bit-wise combined with one of the "Quit" flags to cause the application to restart after it quits.

Methods

createHiddenWindow()

Create the hidden window.

void createHiddenWindow();

Parameters

None.

Creates the initial state of the application by launching tasks specfied by "general.startup.*" prefs.

boolean createStartupState(
  in long aWindowWidth,
  in long aWindowHeight
);

Parameters

aWindowWidth

The width to make the initial window(s) opened.

aWindowHeight

The height to make the initial window(s) opened.

Return value

TRUE if a window was opened.

destroyHiddenWindow()

Destroys the hidden window. This will have no effect if the hidden window has not yet been created.

void destroyHiddenWindow();

Parameters

None.

Starts up the profile manager with the given arguments.

void doProfileStartup(
  in nsICmdLineService aCmdLineService,
  in boolean canInteract
);

Parameters

aCmdLineService

The arguments given to the program.

canInteract

If FALSE and UI is needed, will fail.

Ensures that at least one window exists after creating the startup state. If one has not been made, this will create a browser window.

void ensure1Window(
  in nsICmdLineService aCmdLineService
);

Parameters

aCmdLineService

The command line from which startup args can be read.

enterLastWindowClosingSurvivalArea()

Serves for situations when all application windows will be closed but we don't want to take this as a signal to quit the application. Bracket the code where the last window could close with these.

void enterLastWindowClosingSurvivalArea();

Parameters

None.

exitLastWindowClosingSurvivalArea()

This method serves for situations when all application windows will be closed but we don't want to take this as a signal to quit the application. Bracket the code where the last window could close with these.

void exitLastWindowClosingSurvivalArea();

Parameters

None.

getStartupInfo()

Returns a JavaScript object with events from startup and the timestamps indicating when they occurred.

Parameters

None.

Return value

A JavaScript object with the following fields. Keys are the event names and their values are the times. Events that didn't occur are not in the object.

Example

This example logs startup time information to the console.

var aConsoleService = Components.classes["@mozilla.org/consoleservice;1"]
                      .getService(Components.interfaces.nsIConsoleService);
var startupInfo = Components.classes["@mozilla.org/toolkit/app-startup;1"]
                      .getService(Ci.nsIAppStartup_MOZILLA_2_0).getStartupInfo();
var keys = Object.keys(startupInfo);
keys.sort(function(a, b) { return startupInfo[a] - startupInfo[b]; });
for each (var name in keys) {
  aConsoleService.logStringMessage(name + ": " + startupInfo[name]);
} 

To calculate how long startup took, compute the difference between the event's timestamp and the timestamp of the process event.

Remove the splash screen (if visible). This need be called only once per application session.

void hideSplashScreen();

Parameters

None.

Required initialization routine.

void initialize(
  in nsISupports nativeAppSupportOrSplashScreen
);

Parameters

nativeAppSupportOrSplashScreen

Is an object that can be QI'd to either an nsINativeAppSupport or nsISplashScreen; this object will be used to implement HideSplashScreen.

quit()

Exit the event loop, and shut down the application.

void quit(
  in PRUint32 aMode
);

Parameters

aMode

This parameter modifies how the application is shutdown, and it is constructed from the constants defined above.

restartInSafeMode()

Restart the application in safe mode.

void quit(
  in PRUint32 aQuitMode
);

Parameters

aQuitMode

This parameter modifies how the app is shutdown.

run()

Runs an application event loop: normally the main event pump which defines the lifetime of the application. If there are no windows open and no outstanding calls to enterLastWindowClosingSurvivalArea() this method will exit immediately.

void run();

Parameters

None.

Return value

Returns NS_SUCCESS_RESTART_APP code. This return code indicates that the application should be restarted because quit was called with the eRestart flag.

See also

• nsICmdLineService
• nsIAppStartup_MOZILLA_2_0