nsIUpdateChecker

This interface describes an object that knows how to check for software updates.
1.0
Introduced
Gecko 1.8
Inherits from: nsISupports Last changed in Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

Method overview

void checkForUpdates(in nsIUpdateCheckListener listener, in boolean force);
void stopChecking(in unsigned short duration);

Constants

Constant Value Description
CURRENT_CHECK 1 Constant for the stopChecking() method indicating that only the current update check should be stopped.
CURRENT_SESSION 2 Constant for the stopChecking() method indicating that all update checks during the current session should be stopped.
ANY_CHECKS 3 Constant for the stopChecking() method indicating that all update checking should be stopped. This disables the update checking preferences.

Methods

checkForUpdates()

Checks for available updates, notifying a listener of the results.

void checkForUpdates(
  in nsIUpdateCheckListener listener,
  in boolean force
);
Parameters
listener
An object implementing nsIUpdateCheckListener to be notified of the results of an update check.
force
If true, the update checker checks for updates, regardless of the current value of the user's update settings. This is used by any user interface that offers the user the opportunity to check for updates immediately. The force option doesn't work if the system administrator has locked the app.update.enabled preference.

stopChecking()

Ends any pending update check.

void stopChecking(
  in unsigned short duration
);
Parameters
duration
One of the constants indicating the set of updates to stop.

See also

Document Tags and Contributors

 Contributors to this page: Sheppy, trevorh, Mossop
 Last updated by: Sheppy,