Back to index

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

An interface describing an object that knows how to check for updates. More...

import "nsIUpdateService.idl";

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

List of all members.

Public Member Functions

void checkForUpdates (in nsIUpdateCheckListener listener, in boolean force)
 Checks for available updates, notifying a listener of the results.
void stopChecking (in unsigned short duration)
 Ends any pending update check.

Public Attributes

const unsigned short CURRENT_CHECK = 1
 Constants for the |stopChecking| function that tell the Checker how long to stop checking:
const unsigned short CURRENT_SESSION = 2
const unsigned short ANY_CHECKS = 3

Detailed Description

An interface describing an object that knows how to check for updates.

Definition at line 308 of file nsIUpdateService.idl.


Member Function Documentation

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

Parameters:
listenerAn object implementing nsIUpdateCheckListener which is notified of the results of an update check.
forceForces the checker to check for updates, regardless of the current value of the user's update settings. This is used by any piece of UI that offers the user the imperative option to check for updates now, regardless of their update settings. force will not work if the system administrator has locked the app.update.enabled preference.
void nsIUpdateChecker::stopChecking ( in unsigned short  duration)

Ends any pending update check.

Parameters:
durationA value representing the set of checks to stop doing.

Member Data Documentation

const unsigned short nsIUpdateChecker::ANY_CHECKS = 3

Definition at line 336 of file nsIUpdateService.idl.

Constants for the |stopChecking| function that tell the Checker how long to stop checking:

CURRENT_CHECK: Stops the current (active) check only CURRENT_SESSION: Stops all checking for the current session ANY_CHECKS: Stops all checking, any session from now on (disables update checking preferences)

Definition at line 334 of file nsIUpdateService.idl.

Definition at line 335 of file nsIUpdateService.idl.


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