AddonListener

This article is in need of a technical review.

AddonListeners can be registered with AddonManager.addAddonListener() and will then receive notification of changes to the add-ons currently installed. These notifications come in the form of calls to methods on the listener object. A listener only needs to implement the methods corresponding to the events it cares about; missing methods will not cause any problems.

Method Overview

void onEnabling(in Addon addon, in boolean needsRestart)
void onEnabled(in Addon addon)
void onDisabling(in Addon addon, in boolean needsRestart)
void onDisabled(in Addon addon)
void onInstalling(in Addon addon, in boolean needsRestart)
void onInstalled(in Addon addon)
void onUninstalling(in Addon addon, in boolean needsRestart)
void onUninstalled(in Addon addon)
void onOperationCancelled(in Addon addon)
void onPropertyChanged(in Addon addon, in string properties[])

Methods

onEnabling()

Called when an add-on is about to be enabled.

void onEnabling(
  in Addon addon,
  in boolean needsRestart
)
Parameters
addon
The Addon that is being enabled
needsRestart
True if an application restart is necessary for the change to take effect

onEnabled()

Called when an add-on has been enabled.

void onEnabled(
  in Addon addon,
)
Parameters
addon
The Addon that has been enabled

onDisabling()

Called when an add-on is about to be disabled.

void onDisabling(
  in Addon addon,
  in boolean needsRestart
)
Parameters
addon
The Addon that is being disabled
needsRestart
True if an application restart is necessary for the change to take effect

onDisabled()

Called when an add-on has been disabled.

void onDisabled(
  in Addon addon,
)
Parameters
addon
The Addon that has been disabled

onInstalling()

Called when an add-on is about to be installed.

void onInstalling(
  in Addon addon,
  in boolean needsRestart
)
Parameters
addon
The Addon that is being installed
needsRestart
True if an application restart is necessary for the change to take effect

onInstalled()

Called when an add-on has been installed.

void onInstalled(
  in Addon addon,
)
Parameters
addon
The Addon that has been installed

onUninstalling()

Called when an add-on is about to be uninstalled.

void onUninstalling(
  in Addon addon,
  in boolean needsRestart
)
Parameters
addon
The Addon that is being uninstalled
needsRestart
True if an application restart is necessary for the change to take effect

onUninstalled()

Called when an add-on has been uninstalled.

void onUninstalled(
  in Addon addon,
)
Parameters
addon
The Addon that has been uninstalled

onOperationCancelled()

Called when a pending operation for an add-on is cancelled.

void onOperationCancelled(
  in Addon addon,
)
Parameters
addon
The Addon that has had a pending operation cancelled

onPropertyChanged()

Called when one or more properties of Addon has changed.

Only applies to the following properties:

  • applyBackgroundUpdates
void onPropertyChanged(
  in Addon addon,
  in string properties[]	
)
Parameters
addon
The Addon that has had its properties changed
properties
An array of the names of properties that changed

Document Tags and Contributors

Last updated by: kscarfone,
Hide Sidebar