From Bright Pattern Documentation
< 5.19:Embedded-agent-desktop-sdk-specification | Events
Revision as of 21:14, 7 February 2019 by Tracy (talk | contribs) (Tracy moved page 5.3:Embedded-agent-desktop-sdk-specification/AgentStatus to 5.3:Embedded-agent-desktop-sdk-specification/Events/AgentStatus)
<translate>
onStatusChange(callback)
The Agent Status method gets an agent's state and reason (if any).
Syntax
window.bpspat.api.onStatusChange(callback)
callback = function(data) {
}
Arguments
| Parameter | Type | Description |
| callback | function | JavaScript method executed when API method request is completed |
Response
The response object contains the following fields.
| Name | Data Type | Description |
| data.status | string | agent state (e.g., "Ready", "Not Ready", etc.) |
| data.reason | string | Not Ready reason (e.g., "Break", "Meeting", etc.) |
Example
{
data.status: "Not Ready";
data.reason: "Lunch";
}
</translate>