Interface nsIAuthPromptCallbackType

Interface for callback methods for the asynchronous nsIAuthPrompt2 method. Callers MUST call exactly one method if nsIAuthPrompt2::promptPasswordAsync returns successfully. They MUST NOT call any method on this interface before promptPasswordAsync returns.

Hierarchy

Methods

AddRef QueryInterface Release onAuthAvailable onAuthCancelled

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

onAuthAvailable

  • Authentication information is available.

    Note

    Any exceptions thrown from this method should be ignored.

    Parameters

    • aContext: nsISupports

      The context as passed to promptPasswordAsync

    • aAuthInfo: nsIAuthInformation

      Authentication information. Must be the same object that was passed to promptPasswordAsync.

    Returns void

onAuthCancelled

  • Notification that the prompt was cancelled.

    Parameters

    • aContext: nsISupports

      The context that was passed to promptPasswordAsync.

    • userCancel: boolean

      If false, this prompt was cancelled by calling the the cancel method on the nsICancelable; otherwise, it was cancelled by the user.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc