Public Member Functions | Public Attributes

nsIApplicationUpdateService Interface Reference

An interface describing a global application service that handles performing background update checks and provides utilities for selecting and downloading update patches. More...

import "nsIUpdateService.idl";

Collaboration diagram for nsIApplicationUpdateService:

List of all members.

Public Member Functions

nsIUpdate selectUpdate ([array, size_is(updateCount)] in nsIUpdate updates, in unsigned long updateCount)
 Selects the best update to install from a list of available updates.
void addDownloadListener (in nsIRequestObserver listener)
 Adds a listener that receives progress and state information about the update that is currently being downloaded, e.g.
void removeDownloadListener (in nsIRequestObserver listener)
 Removes a listener that is receiving progress and state information about the update that is currently being downloaded.
AString downloadUpdate (in nsIUpdate update, in boolean background)
void pauseDownload ()
 Pauses the active update download process.

Public Attributes

readonly attribute nsIUpdateChecker backgroundChecker
 The Update Checker used for background update checking.
readonly attribute boolean isDownloading
 Whether or not there is an download happening at the moment.
readonly attribute boolean canCheckForUpdates
 Whether or not the Update Service can check for updates.
readonly attribute boolean canApplyUpdates
 Whether or not the Update Service can download and install updates.

Detailed Description

An interface describing a global application service that handles performing background update checks and provides utilities for selecting and downloading update patches.


Member Function Documentation

void nsIApplicationUpdateService::addDownloadListener ( in nsIRequestObserver  listener  ) 

Adds a listener that receives progress and state information about the update that is currently being downloaded, e.g.

to update a user interface.

Parameters:
listener An object implementing nsIRequestObserver and optionally nsIProgressEventSink that is to be notified of state and progress information as the update is downloaded.
AString nsIApplicationUpdateService::downloadUpdate ( in nsIUpdate  update,
in boolean  background 
)
void nsIApplicationUpdateService::pauseDownload (  ) 

Pauses the active update download process.

void nsIApplicationUpdateService::removeDownloadListener ( in nsIRequestObserver  listener  ) 

Removes a listener that is receiving progress and state information about the update that is currently being downloaded.

Parameters:
listener The listener object to remove.
nsIUpdate nsIApplicationUpdateService::selectUpdate ( [array, size_is(updateCount)] in nsIUpdate  updates,
in unsigned long  updateCount 
)

Selects the best update to install from a list of available updates.

Parameters:
updates An array of updates that are available
updateCount The length of the |updates| array

Member Data Documentation

The Update Checker used for background update checking.

Whether or not the Update Service can download and install updates.

This is a function of whether or not the current user has access privileges to the install directory.

Whether or not the Update Service can check for updates.

This is a function of whether or not application update is disabled by the application and the platform the application is running on.

Whether or not there is an download happening at the moment.


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