From Bright Pattern Documentation
(Updated via BpDeleteTranslateTags script) |
|||
| Line 1: | Line 1: | ||
| − | + | = Agent State= | |
Whenever the [[agent-guide/HowtoInterpretYourCurrentStateInformation|agent state]] changes, the following event will be emitted: | Whenever the [[agent-guide/HowtoInterpretYourCurrentStateInformation|agent state]] changes, the following event will be emitted: | ||
| Line 15: | Line 15: | ||
For the [[agent-guide/HowtoMakeYourselfNotReady|Not Ready state]] with optional indication of the reason (the list of configured Not Ready reasons can be obtained in ''AgentPlace.notReadyReasons'' after a successful login): | For the [[agent-guide/HowtoMakeYourselfNotReady|Not Ready state]] with optional indication of the reason (the list of configured Not Ready reasons can be obtained in ''AgentPlace.notReadyReasons'' after a successful login): | ||
public ResultCode setNotReady(string reason); | public ResultCode setNotReady(string reason); | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:02, 29 May 2024
Agent State
Whenever the agent state changes, the following event will be emitted:
public event StateChangedCallback stateChangedCallback;
The UserState object from the callback provides information about the current agent state and the next agent state.
Methods
The following methods are used to set the agent state:
For the Ready state:
public ResultCode setReady();
For the Not Ready state with optional indication of the reason (the list of configured Not Ready reasons can be obtained in AgentPlace.notReadyReasons after a successful login):
public ResultCode setNotReady(string reason);