Public Member Functions | |
void | retrieveBundleFile () |
Begin downloading the bundle data asynchronously This method begins the asynchronous download of bundle data. Use sbIBundleObserver to monitor progress. | |
void | addBundleObserver (in sbIBundleObserver observer) |
Add a bundle observer This method registers a bundle observer object associated with the download of bundle data in order to get error and completion callbacks. | |
void | removeBundleObserver (in sbIBundleObserver observer) |
Remove a bundle observer This method unregisters a bundle observer object from the list of bundle callbacks. | |
long | getStatus () |
Gets the status of bundle download This method returns the status of the asynchronous bundle download process. | |
nsISupports | getBundleDocument () |
Gets the DOM document describing the downloaded bundle This method returns an interface to the bundle DOM document describing each bundled extension. | |
AString | getTextData () |
Gets the bundle document xml in text format This method returns the xml for the bundle document describing each bundled extension in text format. | |
AString | getBundleVersion () |
Gets the version of the downloaded bundle This method returns the version of the downloaded bundle, as extracted from the document's data. | |
boolean | getExtensionInstallState (in long idx) |
Gets the installation flag for a bundled extension This method returns the installation flag associated with a particular bundled extension. The flag is then used by installSelectedExtensions to determine which, extension should be installed. | |
void | setExtensionInstallState (in long idx, in boolean installstate) |
Sets the installation flag for a bundled extension This method sets the installation flag associated with a particular bundled extension. | |
void | installSelectedExtensions (in nsISupports window) |
Install specified bundled extensions This method installs the extensions whose install flags are set to true. A dialog box showing the installer's progress will be spawned. | |
AString | downloadFile (in AString url, in sbIDownloadObserver observer) |
Download a file This method asynchronously downloads a file from a URL and sends progress callbacks to the specified sbiDownloadObserver object. | |
void | deleteLastDownloadedFile () |
Deletes a temporary download file This method deletes the local file associated with the last downloadFile call. | |
long | installXPI (in AString localFilename) |
Install an extension This method installs an XPI extension previously downloaded locally. | |
void | setNeedRestart (in boolean needed) |
Sets the flag indicating that a restart is needed This method sets the flag indicating that a restart of the application is needed in order for installed extensions to take effect. | |
long | getNeedRestart () |
Gets the flag indicating that a restart is needed This method gets the flag indicating whether a restart of the application is needed or not, in order for installed extensions to take effect. | |
long | getNumExtensions () |
Gets the number of extensions in the bundle document This method returns the number of extensions listed in the bundled document. | |
AString | getExtensionName (in long index) |
Gets the name of an extension from the bundle document This method returns the name of a an extensions listed in the bundled document. | |
AString | getExtensionDesc (in long index) |
Gets the description of an extension from the bundle document This method returns the description of a an extensions listed in the bundled document. | |
AString | getExtensionURL (in long index) |
Gets the URL of an extension from the bundle document This method returns the URL of a an extensions listed in the bundled document. | |
AString | getExtesionId (in long index) |
Gets the Id of an extension from the bundle document This method returns the Id of a an extensions listed in the bundled document. | |
AString | getTempFilename () |
Creates a temporary filename This method returns a temporary filename that is guaranteed not to already exist and points to the user's temporary files' directory. |
Definition at line 23 of file sbIBundle.idl.
void sbIBundle::addBundleObserver | ( | in sbIBundleObserver | observer | ) |
Add a bundle observer This method registers a bundle observer object associated with the download of bundle data in order to get error and completion callbacks.
observer | The observer object to register |
void sbIBundle::deleteLastDownloadedFile | ( | ) |
Deletes a temporary download file This method deletes the local file associated with the last downloadFile call.
url | The url for the file to download | |
observer | The observer object for progress and error callbacks |
AString sbIBundle::downloadFile | ( | in AString | url, | |
in sbIDownloadObserver | observer | |||
) |
Download a file This method asynchronously downloads a file from a URL and sends progress callbacks to the specified sbiDownloadObserver object.
url | The url for the file to download | |
observer | The observer object for progress and error callbacks |
nsISupports sbIBundle::getBundleDocument | ( | ) |
Gets the DOM document describing the downloaded bundle This method returns an interface to the bundle DOM document describing each bundled extension.
AString sbIBundle::getBundleVersion | ( | ) |
Gets the version of the downloaded bundle This method returns the version of the downloaded bundle, as extracted from the document's data.
AString sbIBundle::getExtensionDesc | ( | in long | index | ) |
Gets the description of an extension from the bundle document This method returns the description of a an extensions listed in the bundled document.
index | The index of the extension within the bundle document (zero based) |
boolean sbIBundle::getExtensionInstallState | ( | in long | idx | ) |
Gets the installation flag for a bundled extension This method returns the installation flag associated with a particular bundled extension. The flag is then used by installSelectedExtensions to determine which, extension should be installed.
idx | Index of the extension whose flag you wish to retrieve |
AString sbIBundle::getExtensionName | ( | in long | index | ) |
Gets the name of an extension from the bundle document This method returns the name of a an extensions listed in the bundled document.
index | The index of the extension within the bundle document (zero based) |
AString sbIBundle::getExtensionURL | ( | in long | index | ) |
Gets the URL of an extension from the bundle document This method returns the URL of a an extensions listed in the bundled document.
index | The index of the extension within the bundle document (zero based) |
AString sbIBundle::getExtesionId | ( | in long | index | ) |
Gets the Id of an extension from the bundle document This method returns the Id of a an extensions listed in the bundled document.
index | The index of the extension within the bundle document (zero based) |
long sbIBundle::getNeedRestart | ( | ) |
Gets the flag indicating that a restart is needed This method gets the flag indicating whether a restart of the application is needed or not, in order for installed extensions to take effect.
long sbIBundle::getNumExtensions | ( | ) |
Gets the number of extensions in the bundle document This method returns the number of extensions listed in the bundled document.
long sbIBundle::getStatus | ( | ) |
Gets the status of bundle download This method returns the status of the asynchronous bundle download process.
AString sbIBundle::getTempFilename | ( | ) |
Creates a temporary filename This method returns a temporary filename that is guaranteed not to already exist and points to the user's temporary files' directory.
AString sbIBundle::getTextData | ( | ) |
Gets the bundle document xml in text format This method returns the xml for the bundle document describing each bundled extension in text format.
void sbIBundle::installSelectedExtensions | ( | in nsISupports | window | ) |
Install specified bundled extensions This method installs the extensions whose install flags are set to true. A dialog box showing the installer's progress will be spawned.
window | The parent for the progress dialog box |
long sbIBundle::installXPI | ( | in AString | localFilename | ) |
Install an extension This method installs an XPI extension previously downloaded locally.
localFilenale | The local filename for the XPI to install |
void sbIBundle::removeBundleObserver | ( | in sbIBundleObserver | observer | ) |
Remove a bundle observer This method unregisters a bundle observer object from the list of bundle callbacks.
observer | The observer object to unregister |
void sbIBundle::retrieveBundleFile | ( | ) |
Begin downloading the bundle data asynchronously This method begins the asynchronous download of bundle data. Use sbIBundleObserver to monitor progress.
void sbIBundle::setExtensionInstallState | ( | in long | idx, | |
in boolean | installstate | |||
) |
Sets the installation flag for a bundled extension This method sets the installation flag associated with a particular bundled extension.
idx | Index of the extension whose flag you wish to set |
void sbIBundle::setNeedRestart | ( | in boolean | needed | ) |
Sets the flag indicating that a restart is needed This method sets the flag indicating that a restart of the application is needed in order for installed extensions to take effect.
needed | Value of the flag to set |