Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIUpdatePrompt Interface Reference

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

import "nsIUpdateService.idl";

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

List of all members.

Public Member Functions

void checkForUpdates ()
 Shows a user interface that checks for and then displays the available updates.
void showUpdateAvailable (in nsIUpdate update)
 Show a message advising that an update is available for download and install.
void showUpdateDownloaded (in nsIUpdate update)
 Show a message advising that an update has now been downloaded and that the user should restart their software should be restarted so that the update can be installed.
void showUpdateInstalled (in nsIUpdate update)
 Shows a message detailing the update which was installed.
void showUpdateError (in nsIUpdate update)
 Shows an error message UI telling the user about some kind of update failure, e.g.
void showUpdateHistory (in nsIDOMWindow parent)
 Shows a list of all updates installed to date.

Detailed Description

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

Definition at line 447 of file nsIUpdateService.idl.


Member Function Documentation

Shows a user interface that checks for and then displays the available updates.

Show a message advising that an update is available for download and install.

Parameters:
updateThe update to be downloaded and installed

Show a message advising that an update has now been downloaded and that the user should restart their software should be restarted so that the update can be installed.

Parameters:
updateThe update that was downloaded

Shows an error message UI telling the user about some kind of update failure, e.g.

failure to apply patch.

Parameters:
updateThe nsIUpdate object which we could not install

Shows a list of all updates installed to date.

Parameters:
parentA parent window to anchor this window to. Can be null.

Shows a message detailing the update which was installed.

Parameters:
updateThe nsIUpdate object which was just installed

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