nsIAuthPrompt

IID:2f977d45-5485-11d4-87e2-0010a4e75ef2
Inherits From:nsISupports
Status:UNDER_REVIEW

This interface is implemented by the following components:


Constants

PRUint32 SAVE_PASSWORD_NEVER = 0
PRUint32 SAVE_PASSWORD_FOR_SESSION = 1
PRUint32 SAVE_PASSWORD_PERMANENTLY = 2

Methods

PRBool prompt ( PRUnichar* dialogTitle , PRUnichar* text , PRUnichar* passwordRealm , PRUint32 savePassword , PRUnichar* defaultText , out PRUnichar* result ) PRBool promptPassword ( PRUnichar* dialogTitle , PRUnichar* text , PRUnichar* passwordRealm , PRUint32 savePassword , out PRUnichar* pwd ) PRBool promptUsernameAndPassword ( PRUnichar* dialogTitle , PRUnichar* text , PRUnichar* passwordRealm , PRUint32 savePassword , out PRUnichar* user , out PRUnichar* pwd )

PRBool prompt ( PRUnichar* dialogTitle , PRUnichar* text , PRUnichar* passwordRealm , PRUint32 savePassword , PRUnichar* defaultText , out PRUnichar* result )

Puts up a text input dialog with OK and Cancel buttons.

Arguments:
dialogTitle
text
passwordRealm
savePassword
defaultText
result
Returns:
true for OK, false for Cancel

PRBool promptPassword ( PRUnichar* dialogTitle , PRUnichar* text , PRUnichar* passwordRealm , PRUint32 savePassword , out PRUnichar* pwd )

Puts up a password dialog with OK and Cancel buttons.

Arguments:
dialogTitle
text
passwordRealm
savePassword
pwd
Returns:
true for OK, false for Cancel

PRBool promptUsernameAndPassword ( PRUnichar* dialogTitle , PRUnichar* text , PRUnichar* passwordRealm , PRUint32 savePassword , out PRUnichar* user , out PRUnichar* pwd )

Puts up a username/password dialog with OK and Cancel buttons.

Arguments:
dialogTitle
text
passwordRealm
savePassword
user
pwd
Returns:
true for OK, false for Cancel

References

This interface is the type of the following properties:

nsILDAPAutoCompleteSession.authPrompter, nsISmtpUrl.authPrompt

This interface is passed as an argument to the following methods:

nsISmtpServer.getPasswordWithUI, nsISmtpServer.getUsernamePasswordWithUI

This interface is returned from the following methods:

nsIAuthPromptProvider.getAuthPrompt, nsIWindowWatcher.getNewAuthPrompter

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com