Back to index

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

import "nsIRefreshURI.idl";

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

List of all members.

Public Member Functions

void refreshURI (in nsIURI aURI, in long aMillis, in boolean aRepeat, in boolean aMetaRefresh)
 Load a uri after waiting for aMillis milliseconds.
void setupRefreshURI (in nsIChannel aChannel)
 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.
void setupRefreshURIFromHeader (in nsIURI aBaseURI, in ACString aHeader)
 Parses the passed in header string and sets up a refreshURI if a "refresh" header is found.
void cancelRefreshURITimers ()
 Cancels all timer loads.

Detailed Description

Definition at line 44 of file nsIRefreshURI.idl.


Member Function Documentation

Cancels all timer loads.

void nsIRefreshURI::refreshURI ( in nsIURI  aURI,
in long  aMillis,
in boolean  aRepeat,
in boolean  aMetaRefresh 
)

Load a uri after waiting for aMillis milliseconds.

If the docshell is busy loading a page currently, the refresh request will be queued and executed when the current load finishes.

Parameters:
aUriThe uri to refresh.
aMillisThe number of milliseconds to wait.
aRepeatFlag to indicate if the uri is to be repeatedly refreshed every aMillis milliseconds. aMetaRefresh Flag to indicate if this is a Meta refresh.

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.

Parameters:
aChannelThe channel to be parsed.
void nsIRefreshURI::setupRefreshURIFromHeader ( in nsIURI  aBaseURI,
in ACString  aHeader 
)

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.

Parameters:
aBaseURIbase URI to resolve refresh uri with.
aHeaderThe meta refresh header string.

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