Addon

An Addon represents an add-on that is either installed or can be installed. Instances can be created using the many getAddon methods on the AddonManager object.

The interface can represent many different kinds of add-ons and as such, some of the methods and properties are considered "required" and others "optional," which means that the optional methods or property may not exist on Addon instances for some types of add-ons. API consumers should take care to verify the existence of these methods or properties before relying on them.

Overview of required methods

Overview of optional methods

Required properties

Optional properties

Callbacks

DataDirectoryCallback()

A callback which is passed a directory path, and, when an error has occured, an Error object.

void DataDirectoryCallback(
  in string path,
  in Error error
)

Parameters

path

A string representation of the Addon's data directory.

error

If an error has occured, an Error object relevant to the error, othereise null.

Required Methods

isCompatibleWith()

Tests whether this add-on is known to be compatible with a particular application and platform version.

void isCompatibleWith(
  in string appVersion,
  in string platformVersion
)

Parameters

appVersion

An application version to test against

platformVersion

A platform version to test against

findUpdates()

Starts an update check for this add-on. This will perform asynchronously and deliver results to the given listener.

void findUpdates(
  in UpdateListener listener,
  in integer reason,
  in string appVersion,
  in string platformVersion
)

Parameters

listener

An UpdateListener for the update process

reason

A reason code for performing the update

appVersion

An application version to check for updates for

platformVersion

A platform version to check for updates for

Optional Methods

uninstall()

Uninstalls this add-on. If possible the uninstall will happen immediately, otherwise it will wait until the next application restart.

This method must be defined if an add-on has the permission PERM_CAN_UNINSTALL.

void uninstall(
)

cancelUninstall()

Cancels uninstalling an add-on if it is pending uninstall.

This method must be defined if an add-on has the pendingOperation PENDING_UNINSTALL.

void cancelUninstall(
)

hasResource()

Checks whether a file resource is available for this add-on. For XPI style add-ons, for example, it tests whether the named file was included in the package.

boolean hasResource(
  in string path
)

Parameters

path

A "/" separated path for the resource.

getResourceURI()

Gets an nsIURI to the file resource for this add-on.

nsIURI getResourceURI(
  in string path
)

Parameters

path

A "/" separated path for the resource.

Returns the path of the preferred directory, within the current profile, where an add-on should store data files. If the directory does not already exist, it will be created.

void getDataDirectory(
  in DataDirectoryCallback callback
)