From Bright Pattern Documentation
(Created page with "<translate> = login = Allows users to log into the Agent Desktop application == Request == === ''Syntax'' === {| class="wikitable" |login(loginData: LoginData, force?: boole...") |
|||
| Line 67: | Line 67: | ||
=== Example Request === | === Example Request === | ||
| + | <syntaxhighlight lang="Javascript"> | ||
loginButton.onclick = () => { | loginButton.onclick = () => { | ||
| − | |||
const username = usernameInput.value | const username = usernameInput.value | ||
| − | |||
const password = passwordInput.value | const password = passwordInput.value | ||
| − | |||
const tenant = tenantInput.value | const tenant = tenantInput.value | ||
| − | |||
adApi.login({username: username, password: password, tenant: tenant}) | adApi.login({username: username, password: password, tenant: tenant}) | ||
| − | |||
} | } | ||
| − | + | </syntaxhighlight> | |
=== Return Value === | === Return Value === | ||
null | null | ||
Latest revision as of 16:26, 16 September 2022
• 5.19
login
Allows users to log into the Agent Desktop application
Request
Syntax
| login(loginData: LoginData, force?: boolean): Promise<OperationResult<null>> |
Where:
| type LoginData = {
username: string password: string tenant?: string } |
Parameters
| Parameters | Parameter Values | Data Type | Optional/Required | Description |
| LoginData | ||||
| username | String | Required | The user’s Agent Desktop username | |
| password | String | Required | The user’s Agent Desktop password | |
| tenant | String | Optional | The domain of your tenant (i.e., contact center) | |
| force | true
false |
String | Optional | Set the value to true if you want to force login. |
Example Request
loginButton.onclick = () => {
const username = usernameInput.value
const password = passwordInput.value
const tenant = tenantInput.value
adApi.login({username: username, password: password, tenant: tenant})
}
Return Value
null