public class

ChatAnalytics

extends Object
java.lang.Object
   ↳ com.salesforce.android.chat.core.ChatAnalytics

Class Overview

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.

Summary

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_IS_CHAT_BOT If the agent is a Chatbot
String DATA_LIVE_AGENT_POD The LiveAgent Pod used for Chat sessions.
String DATA_LIVE_AGENT_SESSION_ID The LiveAgent Session ID returned once a Chat session has been created.
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_QUEUE_ESTIMATED_WAIT_TIME The current estimated wait time in the queue.
String DATA_QUEUE_POSITION The current position in the queue.
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_JOINED_CONFERENCE An additional agent has joined the chat session.
String RESPONSE_AGENT_LEFT_CONFERENCE An additional agent has left the chat session.
String RESPONSE_AGENT_REQUEST_FILE_TRANSFER The agent requested a file transfer.
String RESPONSE_AGENT_TRANSFERRED_AGENT The Agent has transferred the session to another agent.
String RESPONSE_CHATBOT_JOINED A Chatbot has joined the chat session.
String RESPONSE_CHATBOT_TRANSFERRED_AGENT A Chatbot has transferred the session to an agent.
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_QUEUE_POSITION The queue position or estimate wait time has been updated.
String RESPONSE_SESSION_CREATED The Chat Session has been created.
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

Constants

public static final String DATA_AGENT_ID

The LiveAgent ID of the Chat agent.

Constant Value: "CHAT_DATA_AGENT_ID"

public static final String DATA_AGENT_NAME

The name of the chat agent.

Constant Value: "CHAT_DATA_AGENT_NAME"

public static final String DATA_BUTTON_ID

The LiveAgent Button ID used to create Chat sessions.

Constant Value: "CHAT_DATA_BUTTON_ID"

public static final String DATA_CURRENT_LIFECYCLE_STATE

The current Chat session lifecycle state.

See Also
Constant Value: "CHAT_DATA_CURRENT_LIFECYCLE_STATE"

public static final String DATA_DEPLOYMENT_ID

The LiveAgent Deployment ID used to create Chat sessions.

Constant Value: "CHAT_DATA_DEPLOYMENT_ID"

public static final String DATA_END_REASON

The reason why the session has ended.

See Also
Constant Value: "CHAT_DATA_END_REASON"

public static final String DATA_ERROR

An error instance that is relevant within the context of an Error event.

See Also
Constant Value: "CHAT_DATA_ERROR"

public static final String DATA_IS_CHAT_BOT

If the agent is a Chatbot

Constant Value: "CHAT_DATA_IS_CHATBOT"

public static final String DATA_LIVE_AGENT_POD

The LiveAgent Pod used for Chat sessions.

Constant Value: "CHAT_DATA_LIVE_AGENT_POD"

public static final String DATA_LIVE_AGENT_SESSION_ID

The LiveAgent Session ID returned once a Chat session has been created.

Constant Value: "CHAT_DATA_LIVE_AGENT_SESSION_ID"

public static final String DATA_ORGANIZATION_ID

The Salesforce Organization ID used to create Chat sessions.

Constant Value: "CHAT_DATA_ORGANIZATION_ID"

public static final String DATA_PREVIOUS_LIFECYCLE_STATE

The previous Chat session lifecycle state.

See Also
Constant Value: "CHAT_DATA_PREVIOUS_LIFECYCLE_STATE"

public static final String DATA_QUEUE_ESTIMATED_WAIT_TIME

The current estimated wait time in the queue.

Constant Value: "CHAT_DATA_QUEUE_ESTIMATED_WAIT_TIME"

public static final String DATA_QUEUE_POSITION

The current position in the queue.

Constant Value: "CHAT_DATA_QUEUE_POSITION"

public static final String DATA_TIMESTAMP

A timestamp that is relevant within the context of an analytics event.

See Also
  • Date
Constant Value: "CHAT_DATA_TIMESTAMP"

public static final String FILE_TRANSFER_BYTES

The size (in bytes) of the file being transferred.

Constant Value: "CHAT_FILE_TRANSFER_BYTES"

public static final String FILE_TRANSFER_STATUS

The status of the file transfer.

See Also
Constant Value: "CHAT_FILE_TRANSFER_STATUS"

public static final String FILE_TRANSFER_TYPE

The media type of the file being transferred.

Constant Value: "CHAT_FILE_TRANSFER_TYPE"

public static final String RESPONSE_AGENT_CANCEL_FILE_TRANSFER

The file transfer was cancelled by the agent.

Constant Value: "CHAT_RESPONSE_AGENT_CANCEL_FILE_TRANSFER"

public static final String RESPONSE_AGENT_HAS_FINISHED_TYPING

The Agent has finished typing.

Constant Value: "CHAT_RESPONSE_AGENT_HAS_FINISHED_TYPING"

public static final String RESPONSE_AGENT_IS_TYPING

The Agent is currently typing.

Constant Value: "CHAT_RESPONSE_AGENT_IS_TYPING"

public static final String RESPONSE_AGENT_JOINED

The Agent has joined the chat session.

Constant Value: "CHAT_RESPONSE_AGENT_JOINED"

public static final String RESPONSE_AGENT_JOINED_CONFERENCE

An additional agent has joined the chat session.

Constant Value: "CHAT_RESPONSE_AGENT_JOINED_CONFERENCE"

public static final String RESPONSE_AGENT_LEFT_CONFERENCE

An additional agent has left the chat session.

Constant Value: "CHAT_RESPONSE_AGENT_LEFT_CONFERENCE"

public static final String RESPONSE_AGENT_REQUEST_FILE_TRANSFER

The agent requested a file transfer.

Constant Value: "CHAT_RESPONSE_AGENT_REQUEST_FILE_TRANSFER"

public static final String RESPONSE_AGENT_TRANSFERRED_AGENT

The Agent has transferred the session to another agent.

Constant Value: "CHAT_RESPONSE_AGENT_TRANSFERRED_AGENT"

public static final String RESPONSE_CHATBOT_JOINED

A Chatbot has joined the chat session.

Constant Value: "CHAT_RESPONSE_CHATBOT_JOINED"

public static final String RESPONSE_CHATBOT_TRANSFERRED_AGENT

A Chatbot has transferred the session to an agent.

Constant Value: "CHAT_RESPONSE_CHATBOT_TRANSFERRED_AGENT"

public static final String RESPONSE_ERROR

An error has occurred.

Constant Value: "CHAT_RESPONSE_ERROR"

public static final String RESPONSE_FILE_TRANSFER_COMPLETE

The user completed a file transfer.

Constant Value: "CHAT_RESPONSE_FILE_TRANSFER_COMPLETE"

public static final String RESPONSE_FILE_TRANSFER_FAILED

The user failed the file transfer.

Constant Value: "CHAT_RESPONSE_FILE_TRANSFER_FAILED"

public static final String RESPONSE_INITIALIZED_CLIENT

The ChatClient has been initialized successfully.

Constant Value: "CHAT_RESPONSE_INITIALIZED_CLIENT"

public static final String RESPONSE_LIFECYCLE_CHANGE

The lifecycle state of the Chat Session has changed.

Constant Value: "CHAT_RESPONSE_LIFECYCLE_CHANGE"

public static final String RESPONSE_MESSAGE_RECEIVED

A message has been received from the Agent.

Constant Value: "CHAT_RESPONSE_MESSAGE_RECEIVED"

public static final String RESPONSE_MESSAGE_SENT

A chat message has been successfully sent to the Agent.

Constant Value: "CHAT_RESPONSE_MESSAGE_SENT"

public static final String RESPONSE_QUEUE_POSITION

The queue position or estimate wait time has been updated.

Constant Value: "CHAT_RESPONSE_QUEUE_POSITION"

public static final String RESPONSE_SESSION_CREATED

The Chat Session has been created.

Constant Value: "CHAT_RESPONSE_SESSION_CREATED"

public static final String RESPONSE_SESSION_ENDED

The Chat Session has ended.

Constant Value: "CHAT_RESPONSE_SESSION_ENDED"

public static final String USER_END_SESSION

The user has requested the termination of the Chat session.

Constant Value: "CHAT_USER_END_SESSION"

public static final String USER_FILE_TRANSFER_UPLOAD_INITIATED

The user file transfer upload has been initiated.

Constant Value: "CHAT_USER_FILE_TRANSFER_UPLOAD_INITIATED"

public static final String USER_HAS_FINISHED_TYPING

The user has finished typing.

Constant Value: "CHAT_USER_HAS_FINISHED_TYPING"

public static final String USER_INITIALIZE_CLIENT

The user has requested a ChatClient instance, which will begin a new Chat session.

Constant Value: "CHAT_USER_INITIALIZE_CLIENT"

public static final String USER_IS_TYPING

The user is currently typing.

Constant Value: "CHAT_USER_IS_TYPING"

public static final String USER_SEND_MESSAGE

The user has sent a chat message.

Constant Value: "CHAT_USER_SEND_MESSAGE"

Public Constructors

public ChatAnalytics ()