9.0 Released! → Native ESM runtimes 🚀, Vite support ⚡️, multi-window apps and more...
Read Announcement

Call Signature ​

ts
function login(
   message: string, 
   userNameHint?: string, 
   passwordHint?: string, 
   userName?: string, 
password?: string): Promise<LoginResult>;

Defined in: ui/dialogs/index.d.ts:107

The login() method displays a login dialog box that prompts the visitor for user name and password.

Parameters ​

ParameterTypeDescription
messagestringThe text to display in the dialog box.
userNameHint?stringThe default text to display as a hint in the username input. Optional.
passwordHint?stringThe default text to display as a hint in the password input. Optional.
userName?stringThe default text to display in the user name input box. Optional.
password?stringThe default text to display in the password input box. Optional.

Returns ​

Promise<LoginResult>

Call Signature ​

ts
function login(
   message: string, 
   userNameHint?: string, 
passwordHint?: string): Promise<LoginResult>;

Defined in: ui/dialogs/index.d.ts:115

The login() method displays a login dialog box that prompts the visitor for user name and password.

Parameters ​

ParameterTypeDescription
messagestringThe text to display in the dialog box.
userNameHint?stringThe default text to display as a hint in the username input. Optional.
passwordHint?stringThe default text to display as a hint in the password input. Optional.

Returns ​

Promise<LoginResult>

Call Signature ​

ts
function login(options: LoginOptions): Promise<LoginResult>;

Defined in: ui/dialogs/index.d.ts:121

The login() method displays a login dialog box that prompts the visitor for user name and password.

Parameters ​

ParameterTypeDescription
optionsLoginOptionsThe options for the dialog box.

Returns ​

Promise<LoginResult>

Previous
isEmbedded
Next
makeParser