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.

nsIPrefetchService

IID:cba513eb-c457-4b93-832c-1a979e66edd1
Inherits From:nsISupports

This interface is intended to be used as a service. To create an object implementing this interface: 

var obj = Components.classes["@mozilla.org/prefetch-service;1"].
            getService(Components.interfaces.nsIPrefetchService);

This interface is implemented by the following components:

Methods

nsISimpleEnumerator enumerateQueue ( PRBool includeNormalItems , PRBool includeOfflineItems ) void prefetchURI ( nsIURI URI , nsIURI referrerURI , nsIDOMNode source , PRBool explicit ) void prefetchURIForOfflineUse ( nsIURI URI , nsIURI referrerURI , nsIDOMNode source , PRBool explicit )

nsISimpleEnumerator enumerateQueue ( PRBool includeNormalItems , PRBool includeOfflineItems )

Enumerate the items in the prefetch queue. Each element in the enumeration is an nsIDOMLoadStatus.

Arguments:
includeNormalItems: include normal prefetch items in the list.
includeOfflineItems: include items being fetched for offline use.

void prefetchURI ( nsIURI URI , nsIURI referrerURI , nsIDOMNode source , PRBool explicit )

Enqueue a request to prefetch the specified URI.

Arguments:
URI: the URI of the document to prefetch
referrerURI: the URI of the referring page
source: the DOM node (such as a tag) that requested this fetch, or null if the prefetch was not requested by a DOM node.
explicit: the link element has an explicit prefetch link type

void prefetchURIForOfflineUse ( nsIURI URI , nsIURI referrerURI , nsIDOMNode source , PRBool explicit )

Enqueue a request to prefetch the specified URI, making sure it's in the offline cache.

Arguments:
URI: the URI of the document to prefetch
referrerURI: the URI of the referring page
source: the DOM node (such as a tag) that requested this fetch, or null if the prefetch was not requested by a DOM node.
explicit: the link element has an explicit offline link type

Reference documentation is generated from Mozilla's source.