From Bright Pattern Documentation
(Created page with "<translate> = getTeams = Get a list of all available agent teams == Request == === Syntax === {| class="wikitable" |getTeams(): Promise<OperationResult<Team[]>> |} Where: {...") |
(Updated via BpDeleteTranslateTags script) |
||
| Line 1: | Line 1: | ||
| − | + | ||
= getTeams = | = getTeams = | ||
| Line 67: | Line 67: | ||
|Displays the number of users in this team | |Displays the number of users in this team | ||
|} | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:01, 29 May 2024
• 5.19
getTeams
Get a list of all available agent teams
Request
Syntax
| getTeams(): Promise<OperationResult<Team[]>> |
Where:
| type Team = {
id: string displayName: string usersCount?: number } |
Parameters
(None)
Example Request
getTeamsButton.onclick = () => {
adApi.getTeams()
}
Return Value
| Object | Object Values | Data Type | Optional?
(Y/N) |
Return Value Description |
| Team | ||||
| id | String | N | The team’s unique ID | |
| displayName | String | N | The team’s display name | |
| usersCount | Number | Y | Displays the number of users in this team |