Interface nsIAuthPromptProviderType

Hierarchy

Methods

AddRef QueryInterface Release getAuthPrompt

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

getAuthPrompt

  • Request a prompt interface for the given prompt reason;

    Throws

    NS_ERROR_NOT_AVAILABLE if no prompt is allowed or available for the given reason.

    Returns

    an nsIAuthPrompt2 interface, or throws NS_ERROR_NOT_AVAILABLE

    Parameters

    • aPromptReason: uint32_t

      The reason for the auth prompt; one of #PROMPT_NORMAL or #PROMPT_PROXY

    • iid: object

      The desired interface, e.g. NS_GET_IID(nsIAuthPrompt2).

    • result: object

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc