Interface nsIAuthPrompt2Type

Asynchronously prompt the user for a username and password. This has largely the same semantics as promptUsernameAndPassword(), but must return immediately after calling and return the entered data in a callback.

If the user closes the dialog using a cancel button or similar, the callback's nsIAuthPromptCallback::onAuthCancelled method must be called. Calling nsICancelable::cancel on the returned object SHOULD close the dialog and MUST call nsIAuthPromptCallback::onAuthCancelled on the provided callback.

This implementation may:

1. Coalesce identical prompts. This means prompts that are guaranteed to want the same auth information from the user. A single prompt will be shown; then the callbacks for all the coalesced prompts will be notified with the resulting auth information.
2. Serialize prompts that are all in the same "context" (this might mean application-wide, for a given window, or something else depending on the user interface) so that the user is not deluged with prompts.

Throw

This method may throw any exception when the prompt fails to queue e.g because of out-of-memory error. It must not throw when the prompt could already be potentially shown to the user. In that case information about the failure has to come through the callback. This way we prevent multiple dialogs shown to the user because consumer may fall back to synchronous prompt on synchronous failure of this method.

@}

Requests a username and a password. Implementations will commonly show a dialog with a username and password field, depending on flags also a domain field.

Retval

true Authentication can proceed using the values in the authInfo object.

Retval

false Authentication should be cancelled, usually because the user did not provide username/password.

Note

Exceptions thrown from this function will be treated like a return value of false.

Deprecated

use asyncPromptAuth