Interface nsIXULRuntimeType

Provides information about the XUL runtime.

Status

UNSTABLE - This interface is not frozen and will probably change in future releases. If you need this functionality to be stable/frozen, please contact Benjamin Smedberg.

Hierarchy

Properties

OS: string

A string tag identifying the current operating system. This is taken from the OS_TARGET configure variable. It will always be available.

XPCOMABI: string

A string tag identifying the binary ABI of the current processor and compiler vtable. This is taken from the TARGET_XPCOM_ABI configure variable. It may not be available on all platforms, especially unusual processor or compiler combinations.

The result takes the form -, for example: x86-msvc ppc-gcc3

This value should almost always be used in combination with "OS".

Throw

NS_ERROR_NOT_AVAILABLE if not available.

accessibilityEnabled: boolean

If true, the accessibility service is running.

accessibilityInstantiator: string

Executable of Windows service that activated accessibility.

accessibleHandlerUsed: boolean

If true, the AccessibleHandler dll is used.

browserTabsRemoteAutostart: boolean

If true, browser tabs may be opened by default in a different process from the main browser UI.

chromeColorSchemeIsDark: boolean

Whether the chrome color-scheme is dark

contentThemeDerivedColorSchemeIsDark: boolean

Whether the content color-scheme derived from the app theme is dark

defaultUpdateChannel: string

The default update channel (MOZ_UPDATE_CHANNEL).

desktopEnvironment: string

Returns the desktop environment identifier. Only meaningful on GTK

distributionID: string

The distribution ID for this build (MOZ_DISTRIBUTION_ID).

drawInTitlebar: boolean

Whether we should draw over the titlebar

fissionAutostart: boolean

Whether Fission should be automatically enabled for new browser windows. This may not match the value of the 'fission.autostart' pref.

This value is guaranteed to remain constant for the length of a browser session.

fissionDecisionStatus: nsIXULRuntime_FissionDecisionStatus

The deciding factor which caused Fission to be enabled or disabled in this session. The string version is the same of the name of the constant, without the leading eFission, and with an initial lower-case letter.

fissionDecisionStatusString: string
inSafeMode: boolean

Whether the application was launched in safe mode.

is64Bit: boolean

Indicates whether the current Firefox build is 64-bit.

isTextRecognitionSupported: boolean

Indicates whether or not text recognition of images supported by the OS.

lastAppBuildID: string

Returns the last application build ID that used the current profile or null if the last build ID could not be found (compatibility.ini was either missing or invalid). Throws NS_ERROR_UNAVAILABLE if called from a content process.

lastAppVersion: string

Returns the last application version that used the current profile or null if the last version could not be found (compatibility.ini was either missing or invalid). Throws NS_ERROR_UNAVAILABLE if called from a content process.

launcherProcessState: uint32_t

Returns a value corresponding to one of the |mozilla::LauncherRegistryInfo::EnabledState| values.

logConsoleErrors: boolean

Whether to write console errors to a log file. If a component encounters startup errors that might prevent the app from showing proper UI, it should set this flag to "true".

maxWebProcessCount: uint32_t

Returns the number of content processes to use for normal web pages. If this value is > 1, then e10s-multi should be considered to be "on".

NB: If browserTabsRemoteAutostart is false, then this value has no meaning and e10s should be considered to be "off"!

processID: number

The system process ID of the caller's process.

processStartupShortcut: string

The path of the shortcut used to start the current process, or "" if none.

Windows Main process only, otherwise throws NS_ERROR_NOT_AVAILABLE

May be mising in some cases where the user did launch from a shortcut:

  • If the updater ran on startup
  • If the AUMID was set before the shortcut could be saved

Throw

NS_ERROR_NOT_AVAILABLE if not available.

processType: number

The type of the caller's process. Returns one of the values above.

remoteType: string

The type of remote content process we're running in. null if we're in the parent/chrome process. This can contain a URI if Fission is enabled, so don't use it for any kind of telemetry.

replacedLockTime: number

Modification time of the profile lock before the profile was locked on this startup. Used to know the last time the profile was used and not closed cleanly. This is set to 0 if there was no existing profile lock.

restartedByOS: boolean

True if this application was started by the OS as part of an automatic restart mechanism (such as RegisterApplicationRestart on Windows).

sessionHistoryInParent: boolean

Whether session history is stored in the parent process.

shouldBlockIncompatJaws: boolean

Temporary, do not use. Indicates if an incompat version of JAWS screen reader software is loaded in our process space.

uniqueProcessID: uint64_t

A globally unique and non-recycled ID of the caller's process.

widgetToolkit: string

A string tag identifying the target widget toolkit in use. This is taken from the MOZ_WIDGET_TOOLKIT configure variable.

win32kExperimentStatus: nsIXULRuntime_ExperimentStatus
win32kLiveStatusTestingOnly: nsIXULRuntime_ContentWin32kLockdownState
win32kSessionStatus: nsIXULRuntime_ContentWin32kLockdownState
windowsDLLBlocklistStatus: boolean

True if Windows DLL blocklist initialized correctly. This is primarily for automated testing purposes.

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Starts a child process. This method is intented to pre-start a content child process so that when it is actually needed, it is ready to go.

    Throw

    NS_ERROR_NOT_AVAILABLE if not available.

    Returns void

  • Signal the apprunner to invalidate caches on the next restart. This will cause components to be autoregistered and all fastload data to be re-created.

    Returns void

Generated using TypeDoc