| java.lang.Object | ||
| ↳ | java.lang.Enum<E extends java.lang.Enum<E>> | |
| ↳ | com.salesforce.android.chat.core.model.ChatSessionState | |
Class Overview
The lifecycle session states for a Chat session are determined by a linear state machine. The order through which the states progress is as follows:
- Ready
- Verification
- Initializing
- Connecting
- InQueue
- Connected
- Ending
- Disconnected
These states will be passed to registered SessionStateListener
instances throughout the duration of the session.
Summary
| Enum Values | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ChatSessionState | Connected | An agent has accepted the chat request. | |||||||||
| ChatSessionState | Connecting | Chat is attempting to connect to LiveAgent with the information provided via
ChatConfiguration. |
|||||||||
| ChatSessionState | Disconnected | The session has ended. | |||||||||
| ChatSessionState | Ending | The session is being stopped and is currently undergoing cleanup procedures. | |||||||||
| ChatSessionState | InQueue | A connection to LiveAgent has been established and the chat request has been placed in the queue. | |||||||||
| ChatSessionState | Initializing | Chat is currently performing initialization tasks on the device. | |||||||||
| ChatSessionState | Ready | Ready is the initial resting state for the session. | |||||||||
| ChatSessionState | Verification | Verifying connection credentials to ensure that they are valid. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
isPostSession()
Determine if this
ChatSessionState represents a post-Connected state where the client is
no longer connected to an Agent and the session is being cleaned up or has ended. | ||||||||||
| static ChatSessionState | valueOf(String name) | ||||||||||
| final static ChatSessionState[] | values() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Enum
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.Comparable
| |||||||||||
Enum Values
public static final ChatSessionState Connected
An agent has accepted the chat request. This state represents an active session with an agent.
The agent's information, status and chat messages will be passed to registered
AgentListener instances.
public static final ChatSessionState Connecting
Chat is attempting to connect to LiveAgent with the information provided via
ChatConfiguration.
public static final ChatSessionState Disconnected
The session has ended. A reason for why the session has ended will be passed to
onSessionEnded(ChatEndReason).
See Also
public static final ChatSessionState Ending
The session is being stopped and is currently undergoing cleanup procedures.
public static final ChatSessionState InQueue
A connection to LiveAgent has been established and the chat request has been placed in the queue.
public static final ChatSessionState Initializing
Chat is currently performing initialization tasks on the device.
public static final ChatSessionState Verification
Verifying connection credentials to ensure that they are valid.
If the getLiveAgentPod() is out of date then it will be updated
for the current session.
Public Methods
public boolean isPostSession ()
Determine if this ChatSessionState represents a post-Connected state where the client is
no longer connected to an Agent and the session is being cleaned up or has ended.
Returns
- True if the session is no longer connected and is being cleaned up.