xul-app

The xul-app module provides facilities for introspecting the application on which your program is running.

With the exception of ids, each of these properties exposes the attribute of the same name on the nsIXULAppInfo interface. For more information, see the MDC documentation.

API Reference

Functions

is(name)

Checks whether the host application is the given application.

name : string

A host application name.

Returns: boolean

True if the host application is name and false otherwise.

isOneOf(names)

Checks whether the host application is one of the given applications.

names : array

An array of host application names.

Returns: boolean

True if the host application is one of the names and false otherwise.

versionInRange(version, lowInclusive, highExclusive)

Compares a given version to a version range. See the MDC documentation for details on version comparisons.

version : string

The version to compare.

lowInclusive : string

The lower bound of the version range to compare. The range includes this bound.

highExclusive : string

The upper bound of the version range to compare. The range does not include this bound.

Returns: boolean

True if version falls in the given range and false otherwise.

Properties

ID : string

The GUID of the host application. For example, for Firefox this value is "{ec8030f7-c20a-464f-9b0e-13a3a9e97384}".

name : string

The host application name. The possible values here are:

  • "Firefox"
  • "Fennec"
  • "Mozilla"
  • "SeaMonkey"
  • "Sunbird"
  • "Thunderbird"

"Firefox"and"Fennec"` are the most commonly used values.

version : string

The host application version.

platformVersion : string

The Gecko/XULRunner platform version.

ids : object

A mapping of application names to their IDs. For example, ids["Firefox"] == "{ec8030f7-c20a-464f-9b0e-13a3a9e97384}".