Public Member Functions

nsIAuthPromptCallback Interface Reference

Interface for callback methods for the asynchronous nsIAuthPrompt2 method. More...

import "nsIAuthPromptCallback.idl";

List of all members.

Public Member Functions

void onAuthAvailable (in nsISupports aContext, in nsIAuthInformation aAuthInfo)
 Authentication information is available.
void onAuthCancelled (in nsISupports aContext, in boolean userCancel)
 Notification that the prompt was cancelled.

Detailed Description

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.


Member Function Documentation

void nsIAuthPromptCallback::onAuthAvailable ( in nsISupports  aContext,
in nsIAuthInformation  aAuthInfo 
)

Authentication information is available.

Parameters:
aContext The context as passed to promptPasswordAsync
aAuthInfo Authentication information. Must be the same object that was passed to promptPasswordAsync.
Note:
Any exceptions thrown from this method should be ignored.
void nsIAuthPromptCallback::onAuthCancelled ( in nsISupports  aContext,
in boolean  userCancel 
)

Notification that the prompt was cancelled.

Parameters:
aContext The context that was passed to promptPasswordAsync.
userCancel If false, this prompt was cancelled by calling the the cancel method on the nsICancelable; otherwise, it was cancelled by the user.

The documentation for this interface was generated from the following file: