Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIUpdateCheckListener Interface Reference

An interface describing an object that listens to the progress of an update check operation. More...

import "nsIUpdateService.idl";

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

List of all members.

Public Member Functions

void onProgress (in nsIXMLHttpRequest request, in unsigned long position, in unsigned long totalSize)
 Called every time there is a progress notification loading the Update Service file.
void onCheckComplete (in nsIXMLHttpRequest request,[array, size_is(updateCount)] in nsIUpdate updates, in unsigned long updateCount)
 The update check was completed.
void onError (in nsIXMLHttpRequest request, in nsIUpdate update)
 An error occurred while loading the remote update service file.

Detailed Description

An interface describing an object that listens to the progress of an update check operation.

This object is notified as the check continues, finishes and if it has an error.

Definition at line 263 of file nsIUpdateService.idl.


Member Function Documentation

void nsIUpdateCheckListener::onCheckComplete ( in nsIXMLHttpRequest  request,
[array, size_is(updateCount)] in nsIUpdate  updates,
in unsigned long  updateCount 
)

The update check was completed.

Parameters:
requestThe nsIXMLHttpRequest handling the update check.
updatesAn array of nsIUpdate objects listing available updates.
updateCountThe size of the |updates| array.

An error occurred while loading the remote update service file.

Parameters:
requestThe nsIXMLHttpRequest handling the update check.
updateA nsIUpdate object that contains details about the error in its |statusText| property.
void nsIUpdateCheckListener::onProgress ( in nsIXMLHttpRequest  request,
in unsigned long  position,
in unsigned long  totalSize 
)

Called every time there is a progress notification loading the Update Service file.

Parameters:
requestThe nsIXMLHttpRequest handling the update check.
positionThe current byte downloaded
totalSizeThe total number of bytes that have to be downloaded

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