Public Member Functions | Public Attributes

extIExtension Interface Reference

Interface representing an extension. More...

import "extIApplication.idl";

Collaboration diagram for extIExtension:

List of all members.

Public Member Functions

NS_SCRIPTABLE NS_IMETHOD GetId (nsAString &aId)=0
 The id of the extension.
NS_SCRIPTABLE NS_IMETHOD GetName (nsAString &aName)=0
 The name of the extension.
NS_SCRIPTABLE NS_IMETHOD GetEnabled (PRBool *aEnabled)=0
 Check if the extension is currently enabled, or not.
NS_SCRIPTABLE NS_IMETHOD GetVersion (nsAString &aVersion)=0
 The version number of the extension.
NS_SCRIPTABLE NS_IMETHOD GetFirstRun (PRBool *aFirstRun)=0
 Indicates whether this is the extension's first run after install.
NS_SCRIPTABLE NS_IMETHOD GetPrefs (extIPreferenceBranch **aPrefs)=0
 The preferences object for the extension.
NS_SCRIPTABLE NS_IMETHOD GetStorage (extISessionStorage **aStorage)=0
 The storage object for the extension.
NS_SCRIPTABLE NS_IMETHOD GetEvents (extIEvents **aEvents)=0
 The events object for the extension.

Public Attributes

readonly attribute AString id
 The id of the extension.
readonly attribute AString name
 The name of the extension.
readonly attribute boolean enabled
 Check if the extension is currently enabled, or not.
readonly attribute AString version
 The version number of the extension.
readonly attribute boolean firstRun
 Indicates whether this is the extension's first run after install.
readonly attribute
extIPreferenceBranch 
prefs
 The preferences object for the extension.
readonly attribute
extISessionStorage 
storage
 The storage object for the extension.
readonly attribute extIEvents events
 The events object for the extension.

Detailed Description

Interface representing an extension.


Member Function Documentation

NS_SCRIPTABLE NS_IMETHOD extIExtension::GetEnabled ( PRBool aEnabled  )  [pure virtual]

Check if the extension is currently enabled, or not.

NS_SCRIPTABLE NS_IMETHOD extIExtension::GetEvents ( extIEvents **  aEvents  )  [pure virtual]

The events object for the extension.

supports: "uninstall"

NS_SCRIPTABLE NS_IMETHOD extIExtension::GetFirstRun ( PRBool aFirstRun  )  [pure virtual]

Indicates whether this is the extension's first run after install.

NS_SCRIPTABLE NS_IMETHOD extIExtension::GetId ( nsAString aId  )  [pure virtual]

The id of the extension.

NS_SCRIPTABLE NS_IMETHOD extIExtension::GetName ( nsAString aName  )  [pure virtual]

The name of the extension.

NS_SCRIPTABLE NS_IMETHOD extIExtension::GetPrefs ( extIPreferenceBranch **  aPrefs  )  [pure virtual]

The preferences object for the extension.

Defaults to the "extensions.<extensionid>." branch.

NS_SCRIPTABLE NS_IMETHOD extIExtension::GetStorage ( extISessionStorage **  aStorage  )  [pure virtual]

The storage object for the extension.

NS_SCRIPTABLE NS_IMETHOD extIExtension::GetVersion ( nsAString aVersion  )  [pure virtual]

The version number of the extension.


Member Data Documentation

readonly attribute boolean extIExtension::enabled

Check if the extension is currently enabled, or not.

readonly attribute extIEvents extIExtension::events

The events object for the extension.

supports: "uninstall"

readonly attribute boolean extIExtension::firstRun

Indicates whether this is the extension's first run after install.

readonly attribute AString extIExtension::id

The id of the extension.

readonly attribute AString extIExtension::name

The name of the extension.

The preferences object for the extension.

Defaults to the "extensions.<extensionid>." branch.

The storage object for the extension.

readonly attribute AString extIExtension::version

The version number of the extension.


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