nsIUpdatePrompt

An interface describing an object that can show various kinds of Update
notification UI to the user.

Methods

checkForUpdates()

Shows the application update checking user interface and checks if there
is an update available.

showUpdateAvailable(update)

Shows the application update available user interface advising that an
update is available for download and install. If the app.update.silent
preference is true or the user interface is already displayed the call will
be a no-op.

Parameters

update The nsIUpdate object to be downloaded and installed

showUpdateDownloaded(update, background)

Shows the application update downloaded user interface advising that an
update has now been downloaded and a restart is necessary to complete the
update. If background is true (e.g. the download was not user initiated)
and the app.update.silent preference is true the call will be a no-op.

Parameters

update The nsIUpdate object that was downloaded
background Less obtrusive UI, starting with a non-modal notification alert

showUpdateInstalled()

Shows the application update installed user interface advising that an
update was installed successfully. If the app.update.silent preference is
true, the app.update.showInstalledUI preference is false, or the user
interface is already displayed the call will be a no-op.

showUpdateError(update)

Shows the application update error user interface advising that an error
occurred while checking for or applying an update. If the app.update.silent
preference is true the call will be a no-op.

Parameters

update An nsIUpdate object representing the update that could not be installed. The nsIUpdate object will not be the actual update when the error occurred during an update check and will instead be an nsIUpdate object with the error information for the update check.

showUpdateHistory(parent)

Shows a list of all updates installed to date.

Parameters

parent An nsIDOMWindow to set as the parent for this window. Can be null.