nsIUpdateCheckListener

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.
1.0
28
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 onCheckComplete(in nsIXMLHttpRequest request, [array, size_is(updateCount)] in nsIUpdate updates, in unsigned long updateCount);
void onError(in nsIXMLHttpRequest request, in nsIUpdate update);
void onProgress(in nsIXMLHttpRequest request, in unsigned long position, in unsigned long totalSize);

Methods

onCheckComplete()

Called when the update check is completed.

void onCheckComplete(
  in nsIXMLHttpRequest request,
  [array, size_is(updateCount)] in nsIUpdate updates,
  in unsigned long updateCount
);
Parameters
request
The nsIXMLHttpRequest object handling the update check.
updates
An array of nsIUpdate objects describing the available updates.
updateCount
The number of updates in the updates array.

onError()

Called when an error occurs while loading the remote update service file.

void onError(
  in nsIXMLHttpRequest request,
  in nsIUpdate update
);
Parameters
request
The nsIXMLHttpRequest object handling the update check.
update
An nsIUpdate object containing details about the error in its statusText attribute.

onProgress()

Called every time there is a progress notification loading the update service file.

void onProgress(
  in nsIXMLHttpRequest request,
  in unsigned long position,
  in unsigned long totalSize
);
Parameters
request
The nsIXMLHttpRequest object handling the update check.
position
The number of bytes downloaded so far.
totalSize
The total number of bytes that need to be downloaded.

See also

Document Tags and Contributors

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