| java.lang.Object | ||
| ↳ | java.lang.Enum<E extends java.lang.Enum<E>> | |
| ↳ | com.salesforce.android.sos.api.SosState | |
Class Overview
Enumeration of the various states of an SOS session. Activities may listen for changes in this
state by implementing the SosListener interface.
The states a session can be in as well as their transitions are illustrated here.
See SosListener to learn how to listen to state changes.
Summary
| Enum Values | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| SosState | AgentJoining | An agent has accepted the session and is currently joining. | |||||||||
| SosState | Connected | The agent has joined the session and an A/V connection has been established. | |||||||||
| SosState | Disconnected | The user has disconnected from the session; the session is ended. | |||||||||
| SosState | Idle | The SOS session is created but has not begun initializing. | |||||||||
| SosState | Initializing | The SOS session is initializing and has not yet been established on the SOS server. | |||||||||
| SosState | Paused | The session is currently paused. | |||||||||
| SosState | PendingDisconnect | The agent has disconnected from the session. | |||||||||
| SosState | Reconnecting | The session is being reconnected after an interruption. | |||||||||
| SosState | WaitingForAgent | The session has been established on the server and is currently waiting to be accepted by an agent. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static SosState | valueOf(String name) | ||||||||||
| final static SosState[] | values() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Enum
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.Comparable
| |||||||||||
Enum Values
public static final SosState AgentJoining
An agent has accepted the session and is currently joining.
public static final SosState Connected
The agent has joined the session and an A/V connection has been established.
public static final SosState Disconnected
The user has disconnected from the session; the session is ended.
public static final SosState Idle
The SOS session is created but has not begun initializing. This is typically when the initial dialog is up waiting for the user to confirm session initiation.
public static final SosState Initializing
The SOS session is initializing and has not yet been established on the SOS server.
public static final SosState PendingDisconnect
The agent has disconnected from the session. The session will disconnect if no other agent connects within 10 seconds.
public static final SosState WaitingForAgent
The session has been established on the server and is currently waiting to be accepted by an agent.