Public Member Functions

nsIAddonInstallListener Interface Reference

Interface for handling download and install progress notifications for add-ons. More...

import "nsIExtensionManager.idl";

List of all members.

Public Member Functions

void onDownloadStarted (in nsIUpdateItem addon)
 Called when an add-on download starts.
void onDownloadProgress (in nsIUpdateItem addon, in unsigned long value, in unsigned long maxValue)
 Progress occurred in the download operation.
void onDownloadEnded (in nsIUpdateItem addon)
 Called when an add-on download is complete.
void onInstallStarted (in nsIUpdateItem addon)
 Called when the extension manager starts to install an add-on either through a call to installItemFromFile or from a webpage triggered install.
void onCompatibilityCheckStarted (in nsIUpdateItem addon)
 Called when an add-on compatibility check starts.
void onCompatibilityCheckEnded (in nsIUpdateItem addon, in long status)
 Called at the end of an add-on compatibility check.
void onInstallEnded (in nsIUpdateItem addon, in long status)
 Called when an add-on install completes.
void onInstallsCompleted ()
 Called when there are no more add-on downloads or installs in progress.

Detailed Description

Interface for handling download and install progress notifications for add-ons.


Member Function Documentation

void nsIAddonInstallListener::onCompatibilityCheckEnded ( in nsIUpdateItem  addon,
in long  status 
)

Called at the end of an add-on compatibility check.

The status will be one of the results from nsIAddonUpdateCheckListener to indicate whether new information was found or not.

Parameters:
addon The add-on that is having its compatibility checked
status The status code from nsIAddonUpdateCheckListener for the update operation
void nsIAddonInstallListener::onCompatibilityCheckStarted ( in nsIUpdateItem  addon  ) 

Called when an add-on compatibility check starts.

This will be called during an install if an add-on is incompatible according to its install.rdf.

Parameters:
addon The add-on that the compatibility check will be for
void nsIAddonInstallListener::onDownloadEnded ( in nsIUpdateItem  addon  ) 

Called when an add-on download is complete.

This will be called for every add-on downloaded.

Parameters:
addon The add-on that finished downloading
void nsIAddonInstallListener::onDownloadProgress ( in nsIUpdateItem  addon,
in unsigned long  value,
in unsigned long  maxValue 
)

Progress occurred in the download operation.

This will be called multiple times during the download of an add-on.

Parameters:
addon The add-on that progress occurred for
value The value of the current progress
maxValue The maximum value |value| can reach
void nsIAddonInstallListener::onDownloadStarted ( in nsIUpdateItem  addon  ) 

Called when an add-on download starts.

This will be called for every add-on downloaded including those started by an add-on update.

Parameters:
addon The add-on that is being downloaded
void nsIAddonInstallListener::onInstallEnded ( in nsIUpdateItem  addon,
in long  status 
)

Called when an add-on install completes.

The status will be 0 on success. any other value constitutes a failed install.

Parameters:
addon The add-on that finished installing
status The status of the installation from nsInstall.h
void nsIAddonInstallListener::onInstallsCompleted (  ) 

Called when there are no more add-on downloads or installs in progress.

void nsIAddonInstallListener::onInstallStarted ( in nsIUpdateItem  addon  ) 

Called when the extension manager starts to install an add-on either through a call to installItemFromFile or from a webpage triggered install.

Parameters:
addon The add-on being installed

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