nsIAuthPromptCallback

Interface for callback methods for the asynchronous nsIAuthPrompt2 method.
1.0
28
Introduced
Gecko 1.9
Inherits from: nsISupports Last changed in Gecko 1.9 (Firefox 3)

Callers must call exactly one method if nsIAuthPrompt2.asyncPromptAuth() returns successfully. They must not call any method on this interface before nsIAuthPrompt2.asyncPromptAuth() returns.

Method overview

void onAuthAvailable(in nsISupports aContext, in nsIAuthInformation aAuthInfo);
void onAuthCancelled(in nsISupports aContext, in boolean userCancel);

Methods

onAuthAvailable()

Authentication information is available.

Note: Any exceptions thrown from this method should be ignored.

void onAuthAvailable(
  in nsISupports aContext,
  in nsIAuthInformation aAuthInfo
);
Parameters
aContext
The context as passed to nsIAuthPrompt2.asyncPromptAuth().
aAuthInfo
Authentication information. Must be the same object that was passed to nsIAuthPrompt2.asyncPromptAuth().

onAuthCancelled()

Notification that the prompt was cancelled.

void onAuthCancelled(
  in nsISupports aContext,
  in boolean userCancel
);
Parameters
aContext
The context that was passed to nsIAuthPrompt2.asyncPromptAuth().
userCancel
If false, this prompt was cancelled by calling the the cancel method on the nsICancelable; otherwise, it was cancelled by the user.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, trevorh, fscholz
Last updated by: Sheppy,