nsIAuthPrompt

Methods

prompt(dialogTitle, text, passwordRealm, savePassword, defaultText, result)

Puts up a text input dialog with OK and Cancel buttons.
Note: prompt uses separate args for the “in” and “out” values of the
input field, whereas the other functions use a single inout arg.

Parameters

dialogText The title for the dialog.
text The text to display in the dialog.
passwordRealm The "realm" the password belongs to: e.g. ldap://localhost/dc=test
savePassword One of the SAVE_PASSWORD_* options above.
defaultText The default text to display in the text input box.
result The value entered by the user if OK was selected.

Returns

true for OK, false for Cancel

promptUsernameAndPassword(dialogTitle, text, passwordRealm, savePassword, user, pwd)

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

Parameters

dialogText The title for the dialog.
text The text to display in the dialog.
passwordRealm The "realm" the password belongs to: e.g. ldap://localhost/dc=test
savePassword One of the SAVE_PASSWORD_* options above.
user The username entered in the dialog.
pwd The password entered by the user if OK was selected.

Returns

true for OK, false for Cancel

promptPassword(dialogTitle, text, passwordRealm, savePassword, pwd)

Puts up a password dialog with OK and Cancel buttons.

Parameters

dialogText The title for the dialog.
text The text to display in the dialog.
passwordRealm The "realm" the password belongs to: e.g. ldap://localhost/dc=test. If a username is specified (http://user@site.com) it will be used when matching existing logins or saving new ones. If no username is specified, only password-only logins will be matched or saved. Note: if a username is specified, the username should be escaped.
savePassword One of the SAVE_PASSWORD_* options above.
pwd The password entered by the user if OK was selected.

Returns

true for OK, false for Cancel

Constants

SAVE_PASSWORD_NEVER

SAVE_PASSWORD_FOR_SESSION

SAVE_PASSWORD_PERMANENTLY