Back to index

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

An interface that describes an object representing an available update to the current application - this update may have several available patches from which one must be selected to download and install, for example we might select a binary difference patch first and attempt to apply that, then if the application process fails fall back to downloading a complete file-replace patch. More...

import "nsIUpdateService.idl";

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

List of all members.

Public Member Functions

nsIUpdatePatch getPatchAt (in unsigned long index)
 Retrieves a patch.
nsIDOMElement serialize (in nsIDOMDocument updates)
 Serializes this update object into a DOM Element.

Public Attributes

attribute AString type
 The type of update: "major" A major new version of the Application "minor" A minor update to the Application (e.g.
attribute AString name
 The name of the update, or "<Application Name> <Update Version>".
attribute AString version
 The Application version of this update.
attribute AString extensionVersion
 The Addon version of this update.
attribute AString buildID
 The Build ID of this update.
attribute AString detailsURL
 The URL to a page which offers details about the content of this update.
attribute AString licenseURL
 The URL to a HTML fragment that contains a license for this update.
attribute AString serviceURL
 The URL to the Update Service that supplied this update.
attribute boolean isCompleteUpdate
 Whether or not the update being downloaded is a complete replacement of the user's existing installation or a patch representing the difference between the new version and the previous version.
attribute boolean isSecurityUpdate
 Whether or not the update is a security update or not.
attribute long long installDate
 When the update was installed.
attribute AString statusText
 A message associated with this update, if any.
readonly attribute nsIUpdatePatch selectedPatch
 The currently selected patch for this update.
attribute AString state
 The state of the selected patch: "downloading" The update is being downloaded.
attribute long errorCode
 A numeric error code that conveys additional information about the state of a failed update.
readonly attribute unsigned long patchCount
 The number of patches supplied by this update.

Detailed Description

An interface that describes an object representing an available update to the current application - this update may have several available patches from which one must be selected to download and install, for example we might select a binary difference patch first and attempt to apply that, then if the application process fails fall back to downloading a complete file-replace patch.

This object also contains information about the update that the front end and other application services can use to learn more about what is going on.

Definition at line 118 of file nsIUpdateService.idl.


Member Function Documentation

Retrieves a patch.

Parameters:
indexThe index of the patch to retrieve.
Returns:
The nsIUpdatePatch at the specified index.

Serializes this update object into a DOM Element.

Parameters:
updatesThe document to serialize into
Returns:
The DOM Element created by the serialization process

Member Data Documentation

The Build ID of this update.

Used to determine a particular build, down to the hour, minute and second of its creation. This allows the system to differentiate between several nightly builds with the same |version| for example.

Definition at line 149 of file nsIUpdateService.idl.

The URL to a page which offers details about the content of this update.

Ideally, this page is not the release notes but some other page that summarizes the differences between this update and the previous, which also links to the release notes.

Definition at line 157 of file nsIUpdateService.idl.

A numeric error code that conveys additional information about the state of a failed update.

If the update is not in the "failed" state, then this value is zero.

TODO: Define typical error codes (for now, see updater/errors.h)

Definition at line 219 of file nsIUpdateService.idl.

The Addon version of this update.

Used by the Extension System to track compatibility of installed addons with this update.

Definition at line 141 of file nsIUpdateService.idl.

When the update was installed.

Definition at line 189 of file nsIUpdateService.idl.

Whether or not the update being downloaded is a complete replacement of the user's existing installation or a patch representing the difference between the new version and the previous version.

Definition at line 177 of file nsIUpdateService.idl.

Whether or not the update is a security update or not.

If this is true, then we present more serious sounding user interface messages to the user.

Definition at line 184 of file nsIUpdateService.idl.

The URL to a HTML fragment that contains a license for this update.

If this is specified, the user is shown the license file after they choose to install the update and they must agree to it before the download commences.

Definition at line 165 of file nsIUpdateService.idl.

The name of the update, or "<Application Name> <Update Version>".

Definition at line 130 of file nsIUpdateService.idl.

The number of patches supplied by this update.

Definition at line 224 of file nsIUpdateService.idl.

The currently selected patch for this update.

Definition at line 199 of file nsIUpdateService.idl.

The URL to the Update Service that supplied this update.

Definition at line 170 of file nsIUpdateService.idl.

The state of the selected patch: "downloading" The update is being downloaded.

"pending" The update is ready to be applied. "applying" The update is being applied. "succeeded" The update was successfully applied. "download-failed" The update failed to be downloaded. "failed" The update failed to be applied.

Definition at line 210 of file nsIUpdateService.idl.

A message associated with this update, if any.

Definition at line 194 of file nsIUpdateService.idl.

The type of update: "major" A major new version of the Application "minor" A minor update to the Application (e.g.

security update)

Definition at line 125 of file nsIUpdateService.idl.

The Application version of this update.

Definition at line 135 of file nsIUpdateService.idl.


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