Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIExtensionManager_MOZILLA_1_8_BRANCH Interface Reference

A temporary interface to allow adding new methods without changing existing interfaces for Gecko 1.8.1. More...

import "nsIExtensionManager.idl";

Inheritance diagram for nsIExtensionManager_MOZILLA_1_8_BRANCH:
Inheritance graph
[legend]
Collaboration diagram for nsIExtensionManager_MOZILLA_1_8_BRANCH:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void cancelUninstallItem (in AString id)
 Cancels a pending uninstall of an item.
void getDependentItemListForID (in AString id, in boolean includeDisabled, out unsigned long itemCount,[retval, array, size_is(itemCount)] out nsIUpdateItem items)
 Retrieves a list of installed nsIUpdateItems of items that are dependent on another item.
void checkForBlocklistChanges ()
 Checks for changes to the blocklist using the local blocklist file, application disables / enables items that have been added / removed from the blocklist, and if there are additions to the blocklist this will inform the user by displaying a list of the items added.
void sortTypeByProperty (in unsigned long type, in AString propertyName, in boolean isAscending)
 Sorts addons of the specified type by the specified property in the Extensions Datasource container starting from the top of their container.
boolean start (in nsICommandLine commandLine)
 Starts the Extension Manager, checking for item changes, additions and removals, and finishing pending operations.
boolean checkForMismatches ()
 Determines if there are incompatible items installed (and offers to upgrade them to newer versions if available, via a UI).
void handleCommandLineArgs (in nsICommandLine cmdline)
 Handle command line flags, e.g.
nsIInstallLocation getInstallLocation (in AString id)
 Gets the Install Location for an item.
void installItemFromFile (in nsIFile xpiFile, in AString installLocationKey)
 Installs an item from a XPI/JAR file into the location specified.
void uninstallItem (in AString id)
 Uninstalls an item.
void enableItem (in AString id)
 Enables a disabled item.
void disableItem (in AString id)
 Disables an enabled item.
void update ([array, size_is(itemCount)] in nsIUpdateItem items, in unsigned long itemCount, in unsigned long versionUpdateOnly, in nsIAddonUpdateCheckListener listener)
 Checks for updates to a list of items.
nsIUpdateItem getItemForID (in AString id)
 Gets a nsIUpdateItem for the item with the specified id.
void getItemList (in unsigned long type, out unsigned long itemCount,[retval, array, size_is(itemCount)] out nsIUpdateItem items)
 Retrieves a list of visible nsIUpdateItems of items matching the specified type.
void getIncompatibleItemList (in AString id, in AString version, in unsigned long type, in boolean includeDisabled, out unsigned long itemCount,[retval, array, size_is(itemCount)] out nsIUpdateItem items)
 Retrieves a list of nsIUpdateItems of items that are incompatible with the supplied parameters.
void addDownloads ([array, size_is(itemCount)] in nsIUpdateItem items, in unsigned long itemCount, in boolean fromChrome)
 Adds active download entries to the UI.
void removeDownload (in AString url)
 Removes an active download from the UI.
long addUpdateListener (in nsIAddonUpdateListener listener)
 Adds a download progress listener so the front end can listen to download and install progress.
void removeUpdateListenerAt (in long index)
 Removes a download progress listener.
void moveToIndexOf (in AString movingID, in AString destinationID)
 Move an Item to the index of another item in its container.
void installExtension (in nsIFile aXPIFile, in unsigned long aFlags)
void installTheme (in nsIFile aJARFile, in unsigned long aFlags)

Public Attributes

readonly attribute
nsISimpleEnumerator 
installLocations
 An enumeration of all registered Install Items.
readonly attribute nsIRDFDataSource datasource
 The Extensions Datasource XXXben - the datasource should be registered with the RDF system, so it can be accessed via rdf:extensions, and not exposed through the API like this.
const unsigned long FLAG_INSTALL_PROFILE = 0x01

Detailed Description

A temporary interface to allow adding new methods without changing existing interfaces for Gecko 1.8.1.

After the 1.8.1 release this interface should not be used.

Definition at line 376 of file nsIExtensionManager.idl.


Member Function Documentation

void nsIExtensionManager::addDownloads ( [array, size_is(itemCount)] in nsIUpdateItem  items,
in unsigned long  itemCount,
in boolean  fromChrome 
) [inherited]

Adds active download entries to the UI.

Parameters:
itemsA list of nsIUpdateItems to entries to add
itemCountThe length of |items|
fromChrometrue when called from chrome false when not called from chrome (e.g. web page)

Adds a download progress listener so the front end can listen to download and install progress.

Parameters:
listenerThe listener to add
Returns:
the index of the added listen in the listener list.

Cancels a pending uninstall of an item.

Parameters:
idThe ID of the item.

Checks for changes to the blocklist using the local blocklist file, application disables / enables items that have been added / removed from the blocklist, and if there are additions to the blocklist this will inform the user by displaying a list of the items added.

XXXrstrong - this method is not terribly useful and was added so we can trigger this check from the additional timer used by blocklisting.

Determines if there are incompatible items installed (and offers to upgrade them to newer versions if available, via a UI).

Returns:
true if there were incompatible items that were disabled and the application needs to restart to re-register components, chrome etc, false otherwise.
void nsIExtensionManager::disableItem ( in AString  id) [inherited]

Disables an enabled item.

Parameters:
idThe GUID of the item.
void nsIExtensionManager::enableItem ( in AString  id) [inherited]

Enables a disabled item.

Parameters:
idThe GUID of the item.
void nsIExtensionManager_MOZILLA_1_8_BRANCH::getDependentItemListForID ( in AString  id,
in boolean  includeDisabled,
out unsigned long  itemCount,
[retval, array, size_is(itemCount)] out nsIUpdateItem  items 
)

Retrieves a list of installed nsIUpdateItems of items that are dependent on another item.

Parameters:
idThe ID of the item that other items depend on.
includeDisabledWhether to include disabled items in the set returned.
countRefThe XPCJS reference to the number of items returned.
Returns:
An array of installed nsIUpdateItems that depend on the item specified by the id parameter.
void nsIExtensionManager::getIncompatibleItemList ( in AString  id,
in AString  version,
in unsigned long  type,
in boolean  includeDisabled,
out unsigned long  itemCount,
[retval, array, size_is(itemCount)] out nsIUpdateItem  items 
) [inherited]

Retrieves a list of nsIUpdateItems of items that are incompatible with the supplied parameters.

Parameters:
idThe id of the application to check compatibility against
versionThe version of the application to check compatibility against
typeThe type of item to return
includeDisabledtrue if disabled items should be included in the result set, false otherwise
countRefThe XPCJS reference to the number of items returned.
Returns:
An array of incompatible nsIUpdateItems.

Gets the Install Location for an item.

Parameters:
idThe GUID of the item
Returns:
The Install Location where the item is installed.
nsIUpdateItem nsIExtensionManager::getItemForID ( in AString  id) [inherited]

Gets a nsIUpdateItem for the item with the specified id.

Parameters:
idThe GUID of the item to construct a nsIUpdateItem for.
Returns:
The nsIUpdateItem representing the item.
void nsIExtensionManager::getItemList ( in unsigned long  type,
out unsigned long  itemCount,
[retval, array, size_is(itemCount)] out nsIUpdateItem  items 
) [inherited]

Retrieves a list of visible nsIUpdateItems of items matching the specified type.

Parameters:
typeThe type of item to return.
countRefThe XPCJS reference to the number of items returned.
Returns:
An array of nsIUpdateItems matching the id/type filter.

XXXben - it would be good if this function took an optional install location.

Handle command line flags, e.g.

-install-global-[extension|theme]

Parameters:
cmdLinethe command line the application was started with XXXben - move this off this API - currently it is only used for global installation, and the apprunner can do this directly with |installItemFromFile|
void nsIExtensionManager::installExtension ( in nsIFile  aXPIFile,
in unsigned long  aFlags 
) [inherited]
void nsIExtensionManager::installItemFromFile ( in nsIFile  xpiFile,
in AString  installLocationKey 
) [inherited]

Installs an item from a XPI/JAR file into the location specified.

Parameters:
xpiFileThe source file to install from. This function stages a copy of this file for persistence across potential application restarts, you are responsible for removing the file you pass in.
installLocationKeyThe name identifier of an Install Location to install into.
void nsIExtensionManager::installTheme ( in nsIFile  aJARFile,
in unsigned long  aFlags 
) [inherited]
void nsIExtensionManager::moveToIndexOf ( in AString  movingID,
in AString  destinationID 
) [inherited]

Move an Item to the index of another item in its container.

Parameters:
movingIDThe ID of an item to be moved.
destinationIDThe ID of an item to move an item to.
void nsIExtensionManager::removeDownload ( in AString  url) [inherited]

Removes an active download from the UI.

Parameters:
urlThe URL of the active download to remove

Removes a download progress listener.

Parameters:
indexThe index of the listener to remove.
void nsIExtensionManager_MOZILLA_1_8_BRANCH::sortTypeByProperty ( in unsigned long  type,
in AString  propertyName,
in boolean  isAscending 
)

Sorts addons of the specified type by the specified property in the Extensions Datasource container starting from the top of their container.

If the addons are already sorted then no action is performed.

Parameters:
typeThe nsIUpdateItem type of the items to sort.
propertyNameThe RDF property name used for sorting.
isAscendingtrue to sort ascending and false to sort descending
boolean nsIExtensionManager::start ( in nsICommandLine  commandLine) [inherited]

Starts the Extension Manager, checking for item changes, additions and removals, and finishing pending operations.

Parameters:
commandLineThe command line the application was started with.
Returns:
true if the application has rewritten the extensions.ini file and needs to restart to register components/chrome etc, false otherwise
void nsIExtensionManager::uninstallItem ( in AString  id) [inherited]

Uninstalls an item.

Parameters:
idThe GUID of the item.
void nsIExtensionManager::update ( [array, size_is(itemCount)] in nsIUpdateItem  items,
in unsigned long  itemCount,
in unsigned long  versionUpdateOnly,
in nsIAddonUpdateCheckListener  listener 
) [inherited]

Checks for updates to a list of items.

Parameters:
itemsAn array of nsIUpdateItems to check for updates for.
itemCountThe length of |items|
versionUpdateOnlyfalse if this check should find the newest versions available, true if it should only find newer target application compatibility information for the currently installed version. 2 if this check should only find target application compatibility information for the currently installed version and synchronize the values.
listenerAn nsIAddonUpdateCheckListener object which will be notified during the update check process.

Member Data Documentation

The Extensions Datasource XXXben - the datasource should be registered with the RDF system, so it can be accessed via rdf:extensions, and not exposed through the API like this.

Definition at line 322 of file nsIExtensionManager.idl.

Definition at line 45 of file nsIExtensionManager.idl.

An enumeration of all registered Install Items.

Definition at line 213 of file nsIExtensionManager.idl.


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