Back to index

lightning-sunbird  0.9+nobinonly
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";

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

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 canUpdate
 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.

Definition at line 352 of file nsIUpdateService.idl.


Member Function Documentation

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:
listenerAn 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 
)

Pauses the active update download process.

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

Parameters:
listenerThe 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:
updatesAn array of updates that are available
updateCountThe length of the |updates| array

Member Data Documentation

The Update Checker used for background update checking.

Definition at line 357 of file nsIUpdateService.idl.

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.

Definition at line 408 of file nsIUpdateService.idl.

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

Definition at line 401 of file nsIUpdateService.idl.


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