java.lang.Object | |
↳ | com.salesforce.android.chat.core.ChatAnalytics |
ChatAnalytics contains identifying information for analytics data that is relayed via the com.salesforce.android.service.common.analytics.ServiceAnalytics API. Analytics data is communicated via the com.salesforce.android.service.common.analytics.ServiceAnalyticsListener interface with a java.util.Map object. Each map key is enumerated here to represent a behavior in Chat and the type of its corresponding value is specified in documentation.
Analytics constants are prefixed with key words that identify what they represent:
Prefix | Description |
---|---|
USER_ | Events that are triggered as a result of user interaction during a Chat session. |
RESPONSE_ | Events that are triggered as a response to user interaction during a Chat session. |
DATA_ | Map Keys for the Event Data, which provide contextual information regarding an analytics event. |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | DATA_AGENT_ID | The LiveAgent ID of the Chat agent. | |||||||||
String | DATA_AGENT_NAME | The name of the Chat agent. | |||||||||
String | DATA_BUTTON_ID | The LiveAgent Button ID used to create Chat sessions. | |||||||||
String | DATA_CURRENT_LIFECYCLE_STATE | The current Chat session lifecycle state. | |||||||||
String | DATA_DEPLOYMENT_ID | The LiveAgent Deployment ID used to create Chat sessions. | |||||||||
String | DATA_END_REASON | The reason why the session has ended. | |||||||||
String | DATA_ERROR | An error instance that is relevant within the context of an Error event. | |||||||||
String | DATA_LIVE_AGENT_POD | The LiveAgent Pod used for Chat sessions. | |||||||||
String | DATA_ORGANIZATION_ID | The Salesforce Organization ID used to create Chat sessions. | |||||||||
String | DATA_PREVIOUS_LIFECYCLE_STATE | The previous Chat session lifecycle state. | |||||||||
String | DATA_TIMESTAMP | A timestamp that is relevant within the context of an analytics event. | |||||||||
String | FILE_TRANSFER_BYTES | The size (in bytes) of the file being transferred. | |||||||||
String | FILE_TRANSFER_STATUS | The status of the file transfer. | |||||||||
String | FILE_TRANSFER_TYPE | The media type of the file being transferred. | |||||||||
String | RESPONSE_AGENT_CANCEL_FILE_TRANSFER | The file transfer was cancelled by the agent. | |||||||||
String | RESPONSE_AGENT_HAS_FINISHED_TYPING | The Agent has finished typing. | |||||||||
String | RESPONSE_AGENT_IS_TYPING | The Agent is currently typing. | |||||||||
String | RESPONSE_AGENT_JOINED | The Agent has joined the chat session. | |||||||||
String | RESPONSE_AGENT_REQUEST_FILE_TRANSFER | The agent requested a file transfer. | |||||||||
String | RESPONSE_ERROR | An error has occurred. | |||||||||
String | RESPONSE_FILE_TRANSFER_COMPLETE | The user completed a file transfer. | |||||||||
String | RESPONSE_FILE_TRANSFER_FAILED | The user failed the file transfer. | |||||||||
String | RESPONSE_INITIALIZED_CLIENT | The ChatClient has been initialized successfully. |
|||||||||
String | RESPONSE_LIFECYCLE_CHANGE | The lifecycle state of the Chat Session has changed. | |||||||||
String | RESPONSE_MESSAGE_RECEIVED | A message has been received from the Agent. | |||||||||
String | RESPONSE_MESSAGE_SENT | A chat message has been successfully sent to the Agent. | |||||||||
String | RESPONSE_SESSION_ENDED | The Chat Session has ended. | |||||||||
String | USER_END_SESSION | The user has requested the termination of the Chat session. | |||||||||
String | USER_FILE_TRANSFER_UPLOAD_INITIATED | The user file transfer upload has been initiated. | |||||||||
String | USER_HAS_FINISHED_TYPING | The user has finished typing. | |||||||||
String | USER_INITIALIZE_CLIENT | The user has requested a ChatClient instance, which will begin a new Chat session. |
|||||||||
String | USER_IS_TYPING | The user is currently typing. | |||||||||
String | USER_SEND_MESSAGE | The user has sent a chat message. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
ChatAnalytics() |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
The LiveAgent ID of the Chat agent.
The name of the Chat agent.
The LiveAgent Button ID used to create Chat sessions.
The current Chat session lifecycle state.
The LiveAgent Deployment ID used to create Chat sessions.
An error instance that is relevant within the context of an Error event.
The LiveAgent Pod used for Chat sessions.
The Salesforce Organization ID used to create Chat sessions.
The previous Chat session lifecycle state.
A timestamp that is relevant within the context of an analytics event.
The size (in bytes) of the file being transferred.
The status of the file transfer.
The media type of the file being transferred.
The file transfer was cancelled by the agent.
The Agent has finished typing.
The Agent is currently typing.
The Agent has joined the chat session.
The agent requested a file transfer.
An error has occurred.
The user completed a file transfer.
The user failed the file transfer.
The ChatClient
has been initialized successfully.
The lifecycle state of the Chat Session has changed.
A message has been received from the Agent.
A chat message has been successfully sent to the Agent.
The Chat Session has ended.
The user has requested the termination of the Chat session.
The user file transfer upload has been initiated.
The user has finished typing.
The user has requested a ChatClient
instance, which will begin a new Chat session.
The user is currently typing.
The user has sent a chat message.