Register | Log in

Mozilla.com

  1. MDC
  2. Main Page
  3. nsIUpdatePrompt
Table of contents
  1. 1. Method overview
  2. 2. Methods
    1. 2.1. checkForUpdates()
          1. 2.1.1.1.1. Parameters
    2. 2.2. showUpdateAvailable()
          1. 2.2.1.1.1. Parameters
    3. 2.3. showUpdateDownloaded()
          1. 2.3.1.1.1. Parameters
    4. 2.4. showUpdateError()
          1. 2.4.1.1.1. Parameters
    5. 2.5. showUpdateHistory()
          1. 2.5.1.1.1. Parameters
    6. 2.6. showUpdateInstalled()
          1. 2.6.1.1.1. Parameters
  3. 3. See also

nsIUpdatePrompt

The nsIUpdatePrompt interface describes an object that can be used to show various update-related notifications to the user.


nsIUpdatePrompt is defined in toolkit/mozapps/update/public/nsIUpdateService.idl . It is scriptable and unfrozen (hasn't changed since Mozilla 1.9) .

Inherits from: nsISupports

Method overview

void checkForUpdates();
void showUpdateAvailable(in nsIUpdate update);
void showUpdateDownloaded(in nsIUpdate update, [optional] in boolean background);
void showUpdateError(in nsIUpdate update);
void showUpdateHistory(in nsIDOMWindow parent);
void showUpdateInstalled(in nsIUpdate update);

Methods

checkForUpdates()

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

 void checkForUpdates();
Parameters

None.

showUpdateAvailable()

Shows a message advising the user that an update is available to be downloaded and installed. 

 void showUpdateAvailable(
   in nsIUpdate update
 );
Parameters
update
An nsIUpdate describing the update that's available.

showUpdateDownloaded()

Shows a message advising the user that an update has been downloaded, and that the user should restart the application in order to install it. 

 void showUpdateDownloaded(
   in nsIUpdate update,
   [optional] in boolean background
 );
Parameters
update
An nsIUpdate describing the update that was downloaded.
background
An optional parameter that, if provided and true, presents a less-obtrusive, non-modal notification alert.

showUpdateError()

Displays an error message telling the user about an update failure, such as a failure to successfully apply a patch. 

 void showUpdateError(
   in nsIUpdate update
 );
Parameters
update
An nsIUpdate describing the update that failed to install.

showUpdateHistory()

Shows a list of all updates that have been installed to date. 

 void showUpdateHistory(
   in nsIDOMWindow parent
 );
Parameters
parent
An nsIDOMWindow indicating the parent window to which to anchor the update list window. This can be null.

showUpdateInstalled()

Shows a message detailing the update that was just installed. 

 void showUpdateInstalled(
   in nsIUpdate update
 );
Parameters
update
An nsIUpdate describing the update that was installed.

Page last modified 19:53, 19 Mar 2008 by Sheppy

Tags:

Files (0)