From Bright Pattern Documentation
Jump to: navigation, search
• 5.19 • 5.3 • 5.8

<translate>

Agent Status

The Agent Status method gets an agent's state and reason (if any).

Syntax

window.bpspat.api.onStatusChange(callback)
callback = function(data) {
}

Parameters

Parameter Type Description
callback function (data) JavaScript method executed when API method request is completed


Response

The response object contains the following fields.

Name Description
data.status Agent state (e.g., "Ready", "Not Ready", etc.)
data.reason Not Ready reason (e.g., "Break", "Meeting", etc.)

Example

{
	data.status: "Not Ready";
	data.reason: "Lunch";
}


</translate>

< Previous | Next >