WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIOfflineCacheUpdate

IID:7dc06ede-1098-4384-b95e-65525ab254c9
Inherits From:nsISupports

This interface is implemented by the following components:

Properties

readonly PRUint32 count

Access to the list of items in the update.

readonly nsIURI manifestURI

The manifest for the offline application being updated.

readonly PRBool partial

TRUE if the update is being used to add specific resources. FALSE if the complete cache update process is happening.

readonly PRUint16 status

Fetch the status of the running update. This will return a value defined in nsIDOMOfflineResourceList.

readonly PRBool succeeded

TRUE if the cache update completed successfully.

readonly ACString updateDomain

The domain being updated, and the domain that will own any URIs added with this update.

Methods

void addDynamicURI ( nsIURI URI ) void addObserver ( nsIOfflineCacheUpdateObserver observer , PRBool holdWeak ) void init ( PRBool partialUpdate , nsIURI manifestURI , nsIURI documentURI ) nsIDOMLoadStatus item ( PRUint32 index ) void removeObserver ( nsIOfflineCacheUpdateObserver observer ) void schedule ( )

void addDynamicURI ( nsIURI URI )

Add a URI to the offline cache as part of the update.

Arguments:
URI: The URI to add.

void addObserver ( nsIOfflineCacheUpdateObserver observer , PRBool holdWeak )

Observe loads that are added to the update.

Arguments:
observer: object that notifications will be sent to.
holdWeak: TRUE if you want the update to hold a weak reference to the observer, FALSE for a strong reference.

void init ( PRBool partialUpdate , nsIURI manifestURI , nsIURI documentURI )

Initialize the update.

Arguments:
partialUpdate: TRUE if the update should just update the URIs given to it, FALSE if all URLs for the owner domain should be added.
manifestURI: The manifest URI to be checked, or for partial updates the manifest that should own resources that are added.
documentURI: The page that is requesting the update.

nsIDOMLoadStatus item ( PRUint32 index )

Arguments:
index

void removeObserver ( nsIOfflineCacheUpdateObserver observer )

Remove an observer from the update.

Arguments:
observer: the observer to remove.

void schedule ( )

Add the update to the offline update queue. An offline-cache-update-added event will be sent to the observer service.

References

This interface is passed as an argument to the following methods:

nsIOfflineCacheUpdateObserver.checking, nsIOfflineCacheUpdateObserver.downloading, nsIOfflineCacheUpdateObserver.error, nsIOfflineCacheUpdateObserver.itemCompleted, nsIOfflineCacheUpdateObserver.itemStarted, nsIOfflineCacheUpdateObserver.noUpdate

This interface is returned from the following methods:

nsIOfflineCacheUpdateService.getUpdate, nsIOfflineCacheUpdateService.scheduleUpdate

Reference documentation is generated from Mozilla's source.