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.

nsIRefreshURI

IID:cb0ad623-6b46-4c09-a473-c1d6ca63d3c7
Inherits From:nsISupports

This interface is implemented by the following components:


Properties

readonly PRBool refreshPending

True when there are pending refreshes, false otherwise.


Methods

void cancelRefreshURITimers ( ) void forceRefreshURI ( nsIURI URI , PRInt32 millis , PRBool metaRefresh ) void refreshURI ( nsIURI URI , PRInt32 millis , PRBool repeat , PRBool metaRefresh ) void setupRefreshURI ( nsIChannel channel ) void setupRefreshURIFromHeader ( nsIURI baseURI , ACString header )

void cancelRefreshURITimers ( )

Cancels all timer loads.


void forceRefreshURI ( nsIURI URI , PRInt32 millis , PRBool metaRefresh )

Loads a URI immediately as if it were a refresh.

Arguments:
URI: The URI to refresh.
millis: The number of milliseconds by which this refresh would be delayed if it were not being forced.
metaRefresh: Flag to indicate if this is a meta refresh.

void refreshURI ( nsIURI URI , PRInt32 millis , PRBool repeat , PRBool metaRefresh )

Load a uri after waiting for millis milliseconds. If the docshell is busy loading a page currently, the refresh request will be queued and executed when the current load finishes.

Arguments:
URI
millis: The number of milliseconds to wait.
repeat: Flag to indicate if the uri is to be repeatedly refreshed every millis milliseconds.
metaRefresh: Flag to indicate if this is a Meta refresh.

void setupRefreshURI ( nsIChannel channel )

Checks the passed in channel to see if there is a refresh header, if there is, will setup a timer to refresh the uri found in the header. If docshell is busy loading a page currently, the request will be queued and executed when the current page finishes loading.

Returns the NS_REFRESHURI_HEADER_FOUND success code if a refresh header was found and successfully setup.

Arguments:
channel: The channel to be parsed.

void setupRefreshURIFromHeader ( nsIURI baseURI , ACString header )

Parses the passed in header string and sets up a refreshURI if a "refresh" header is found. If docshell is busy loading a page currently, the request will be queued and executed when the current page finishes loading.

Arguments:
baseURI: base URI to resolve refresh uri with.
header: The meta refresh header string.

Reference documentation is generated from Mozilla's source.