Interface nsIRefreshURIType

Hierarchy

Properties

refreshPending

Methods

AddRef QueryInterface Release cancelRefreshURITimers forceRefreshURI refreshURI

Properties

Readonly refreshPending

refreshPending: boolean

True when there are pending refreshes, false otherwise.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

cancelRefreshURITimers

  • Cancels all timer loads.

    Returns void

forceRefreshURI

  • Loads a URI immediately as if it were a meta refresh.

    Parameters

    • aURI: nsIURI

      The URI to refresh.

    • aPrincipal: nsIPrincipal

      The triggeringPrincipal for the refresh load May be null, in which case the principal of current document will be applied.

    • aMillis: number

      The number of milliseconds by which this refresh would be delayed if it were not being forced.

    Returns void

refreshURI

  • Load a uri after waiting for aMillis milliseconds (as a result of a meta refresh). If the docshell is busy loading a page currently, the refresh request will be queued and executed when the current load finishes.

    Parameters

    • aURI: nsIURI
    • aPrincipal: nsIPrincipal

      The triggeringPrincipal for the refresh load May be null, in which case the principal of current document will be applied.

    • aMillis: number

      The number of milliseconds to wait.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc