Public Member Functions | Public Attributes

nsIAuthPrompt Interface Reference

import "nsIAuthPrompt.idl";

Inheritance diagram for nsIAuthPrompt:

List of all members.

Public Member Functions

boolean prompt (in wstring dialogTitle, in wstring text, in wstring passwordRealm, in PRUint32 savePassword, in wstring defaultText, out wstring result)
 Puts up a text input dialog with OK and Cancel buttons.
boolean promptUsernameAndPassword (in wstring dialogTitle, in wstring text, in wstring passwordRealm, in PRUint32 savePassword, inout wstring user, inout wstring pwd)
 Puts up a username/password dialog with OK and Cancel buttons.
boolean promptPassword (in wstring dialogTitle, in wstring text, in wstring passwordRealm, in PRUint32 savePassword, inout wstring pwd)
 Puts up a password dialog with OK and Cancel buttons.

Public Attributes

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

Detailed Description

Status:
UNDER_REVIEW

Member Function Documentation

boolean nsIAuthPrompt::prompt ( in wstring  dialogTitle,
in wstring  text,
in wstring  passwordRealm,
in PRUint32  savePassword,
in wstring  defaultText,
out wstring  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
boolean nsIAuthPrompt::promptPassword ( in wstring  dialogTitle,
in wstring  text,
in wstring  passwordRealm,
in PRUint32  savePassword,
inout wstring  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
boolean nsIAuthPrompt::promptUsernameAndPassword ( in wstring  dialogTitle,
in wstring  text,
in wstring  passwordRealm,
in PRUint32  savePassword,
inout wstring  user,
inout wstring  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

Member Data Documentation


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