From Bright Pattern Documentation
Jump to: navigation, search
 
 
Line 1: Line 1:
 
<translate>= Agent State=
 
<translate>= 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:
  
::''public event StateChangedCallback stateChangedCallback;''
+
public event StateChangedCallback stateChangedCallback;
 
 
  
 
The ''UserState'' object from the callback provides information about the current agent state and the next agent state.
 
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:
 
The following methods are used to set the agent state:
  
* For the [[agent-guide/HowtoMakeYourselfReady|Ready state]],
+
For the [[agent-guide/HowtoMakeYourselfReady|Ready state]]:
 +
public ResultCode setReady();
  
::''public ResultCode setReady();''
 
  
* 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);''
 
  
  
  
<center>[[desktop-integration-api-net-version-tutorial/AgentLogin|< Previous]]  |  [[desktop-integration-api-net-version-tutorial/Services|Next >]]</center>
 
 
</translate>
 
</translate>

Latest revision as of 01:22, 7 May 2019

• 5.19 • 5.2 • 5.3 • 5.8

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);


< Previous | Next >