nsIAuthPromptProvider

From MDC

The nsIAuthPromptProvider interface requests a prompt interface for the given prompt reason.

Contents 1 Method overview 2 Constants 3 Methods 3.1 getAuthPrompt() 3.1.1 Parameters 3.1.2 Exceptions thrown

nsIAuthPromptProvider is defined in netwerk/base/public/nsIAuthPromptProvider.idl. It is scriptable and unfrozen (hasn't changed since Mozilla 1.9).

Inherits from: nsISupports

[edit] Method overview

void getAuthPrompt(in PRUint32 aPromptReason, in nsIIDRef iid, [iid_is(iid),retval] out nsQIResult result);

[edit] Constants

Constant	Value	Description
PROMPT_NORMAL	0	Normal (non-proxy) prompt request.
PROMPT_PROXY	1	Proxy auth request.

[edit] Methods

[edit] getAuthPrompt()

This method requests a prompt interface for the given prompt reason.

 void getAuthPrompt(
   in PRUint32 aPromptReason, 
   in nsIIDRef iid,
   [iid_is(iid),retval] out nsQIResult result
 );

[edit] Parameters

aPromptReason

The reason for the auth prompt, PROMPT_NORMAL or PROMPT_PROXY.

iid

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

result

A nsIAuthPrompt2 interface, or throws NS_ERROR_NOT_AVAILABLE exception.

[edit] Exceptions thrown

NS_ERROR_NOT_AVAILABLE

If no prompt is allowed or available for the given reason.