Login.getLoginDialogSettings (Method)
Returns a structure containing login dialog settings. This includes customization made using CommonSpot's event hook.
Returns:
Login_GetLoginDialogSettings_Result (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| backurl | PlainText | The URL to send the user to upon a failed login attempt. The URL will be opened up in the same window the login form was shown in. |
| dlgCaption | PlainText | The login dialog box's caption text, which is the text inside the blue bar, The default is 'User Login'. |
| dlgDesc | PlainText | The description under the dialog box's caption, The default is 'Please enter your user name and password'. |
| EmailLoginText | PlainText | The text for the 'Show Email Login' button. The default is 'Email Login'. |
| hideChangePassword | Boolean | Boolean value which when set to true tells CommonSpot that is should remove the change password button from the dialog box. |
| passwordDesc | PlainText | The description under the password label. The default is 'Enter your password'. |
| passwordLabel | PlainText | The password's label. The default is 'Password'. |
| passwordValidationMsg | PlainText | The JavaScript validation message. The default is 'Please enter a password'. |
| permitSpacesInName | Boolean | Boolean flag which when set to true tells CommonSpot that the userid's can contain spaces. |
| retryDesc | PlainText | The retry error message (which is displayed in red). The default is: 'Invalid Credentials entered or restricted IP address'. |
| retryMsg | PlainText | The retry description. The default is 'Please re-enter your user name and password'. |
| retryMsgBadIP | PlainText | The retry message if CommonSpot detects a bad IP address. |
| ShowEmailLogin | Boolean | Boolean flag which when set to true allows users to have their password emailed to them. |
| useridDesc | PlainText | The label for the user ID field. The default is 'UserID'. |
| useridLabel | PlainText | The description under the userid label. The default is 'Enter the User ID assigned to you'. |
| useridValidationMsg | PlainText | The JavaScript validation message, The default is 'Please enter a valid user name'. |
Context:
| License Requirements | None |
| Permission Requirements | (none) |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | This method may be customized at the customer level |
Error Codes:
None
Notes:
None