public class

CasesUIAnalytics

extends Object
java.lang.Object
   ↳ com.salesforce.android.cases.ui.CasesUIAnalytics

Class Overview

CasesUIAnalytics contains identifying information for analytics data that is relayed via the ServiceAnalytics API. Analytics data is communicated via the ServiceAnalyticsListener interface with a Map object. Each map key is enumerated here to represent a behavior in the Cases UI 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 with the Cases UI.
RESPONSE_ Events that are triggered as a response to user interaction with the Cases UI.
DATA_ Map Keys for the Event Data, which provide contextual information regarding an analytics event.
VALUE_ Map Values for the Event Data, which provide contextual information regarding an analytics event.

Summary

Nested Classes
@interface CasesUIAnalytics.CompletionType The result of an operation. 
@interface CasesUIAnalytics.EventType A string representing the type of user event that occurred. 
@interface CasesUIAnalytics.UserType The user who initiated a change. 
Constants
String DATA_CASE_COUNT The number of cases in the case list.
String DATA_CASE_CREATED_RESULT The case created result.
String DATA_CASE_ID The case Id.
String DATA_CASE_LIST_NAME The Case List Name that Cases UI has been configured with.
String DATA_COMMUNITY_URL The Community URL that Cases UI has been configured with.
String DATA_CREATE_CASE_ACTION_NAME The Create Case Action Name that Cases UI has been configured with.
String DATA_EVENT_TYPE The event type.
String DATA_SENDER The sender of a case message.
String DATA_SUBJECT The notification message.
String DATA_USER_TYPE The User Type for the user.
String DATA_WORD_COUNT The number of words entered in the case publisher.
String RESPONSE_MESSAGE_EVENT Emitted when a update to a case feed is received or when a user successfully posts a comment to a case feed.
String RESPONSE_NOTIFICATION_EVENT Emitted when a push notification is received indicating a case has been updated.
String USER_CASE_DETAIL_EVENT The user has navigated to/from the case details feed.
String USER_CASE_LIST_EVENT The user has navigated to/from the case list.
String USER_CASE_PUBLISHER_LAYOUT_EVENT The user has navigated to/from the case publisher.
String USER_CASE_SUBMISSION_EVENT The user has submitted a new case via the publisher.
String USER_EXIT_PUBLISHER_WITH_DATA_ENTERED_EVENT Emitted when a user exits the case publisher.
String VALUE_CASE_ACTOR_AGENT A value indicating an operation was initiated by a remote user.
String VALUE_CASE_ACTOR_CUSTOMER A value indicating an operation was initiated by the user on the device
String VALUE_CASE_DETAIL_DISMISSED A value indicating the case detail feed was closed by the user.
String VALUE_CASE_DETAIL_LAUNCHED A value indicating the user launched the case detail feed.
String VALUE_CASE_DETAIL_LOADED A value indicating the case detail feed loaded.
String VALUE_CASE_LIST_DISMISSED A value indicating the user closed the case list.
String VALUE_CASE_LIST_LAUNCHED A value indicating the user launched the case list.
String VALUE_CASE_LIST_LOADED A value indicating the case list loaded successfully.
String VALUE_CASE_OPERATION_FAILURE A value indicating an operation failed.
String VALUE_CASE_OPERATION_SUCCESS A value indicating an operation completed successfully.
String VALUE_CASE_PUBLISHER_DISMISSED A value indicating the user closed the case publisher.
String VALUE_CASE_PUBLISHER_LAUNCHED A value indicating the user launched the case publisher.
String VALUE_CASE_PUBLISHER_LOADED A value indicating the case publisher completed loading.
String VALUE_CASE_SUBMIT_COMPLETE A value indicating user case submission completed successfully.
String VALUE_CASE_SUBMIT_STARTED A value indicating the user submitted a new case.
String VALUE_CASE_USER_TYPE_AUTHENTICATED A value indicating the user has logged into a community or org.
String VALUE_CASE_USER_TYPE_GUEST A value indicating the user has not logged in.
Public Constructors
CasesUIAnalytics()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String DATA_CASE_COUNT

The number of cases in the case list.

Constant Value: "caseCount"

public static final String DATA_CASE_CREATED_RESULT

The case created result.

See Also
Constant Value: "result"

public static final String DATA_CASE_ID

The case Id.

Constant Value: "caseId"

public static final String DATA_CASE_LIST_NAME

The Case List Name that Cases UI has been configured with.

Constant Value: "caseListname"

public static final String DATA_COMMUNITY_URL

The Community URL that Cases UI has been configured with.

Constant Value: "communityUrl"

public static final String DATA_CREATE_CASE_ACTION_NAME

The Create Case Action Name that Cases UI has been configured with.

Constant Value: "createCaseActionName"

public static final String DATA_EVENT_TYPE

The event type.

See Also
Constant Value: "eventType"

public static final String DATA_SENDER

The sender of a case message.

See Also
Constant Value: "sender"

public static final String DATA_SUBJECT

The notification message.

Constant Value: "subject"

public static final String DATA_USER_TYPE

The User Type for the user. May be guest or authenticated.

Constant Value: "userType"

public static final String DATA_WORD_COUNT

The number of words entered in the case publisher.

Constant Value: "wordCount"

public static final String RESPONSE_MESSAGE_EVENT

Emitted when a update to a case feed is received or when a user successfully posts a comment to a case feed.

Constant Value: "CASE_RESPONSE_MESSAGE_EVENT"

public static final String RESPONSE_NOTIFICATION_EVENT

Emitted when a push notification is received indicating a case has been updated.

Constant Value: "CASE_RESPONSE_NOTIFICATION_EVENT"

public static final String USER_CASE_DETAIL_EVENT

The user has navigated to/from the case details feed.

Constant Value: "CASE_USER_CASE_DETAIL_EVENT"

public static final String USER_CASE_LIST_EVENT

The user has navigated to/from the case list.

Constant Value: "CASE_USER_CASE_LIST_EVENT"

public static final String USER_CASE_PUBLISHER_LAYOUT_EVENT

The user has navigated to/from the case publisher.

Constant Value: "CASE_USER_CASE_PUBLISHER_LAYOUT_EVENT"

public static final String USER_CASE_SUBMISSION_EVENT

The user has submitted a new case via the publisher.

Constant Value: "CASE_USER_CASE_SUBMISSION_EVENT"

public static final String USER_EXIT_PUBLISHER_WITH_DATA_ENTERED_EVENT

Emitted when a user exits the case publisher. Indicates the number of words in the discarded case.

Constant Value: "CASE_USER_EXIT_PUBLISHER_WITH_DATA_ENTERED_EVENT"

public static final String VALUE_CASE_ACTOR_AGENT

A value indicating an operation was initiated by a remote user.

Constant Value: "agent"

public static final String VALUE_CASE_ACTOR_CUSTOMER

A value indicating an operation was initiated by the user on the device

Constant Value: "customer"

public static final String VALUE_CASE_DETAIL_DISMISSED

A value indicating the case detail feed was closed by the user.

Constant Value: "detail_dismissed"

public static final String VALUE_CASE_DETAIL_LAUNCHED

A value indicating the user launched the case detail feed.

Constant Value: "detail_launched"

public static final String VALUE_CASE_DETAIL_LOADED

A value indicating the case detail feed loaded.

Constant Value: "detail_loaded"

public static final String VALUE_CASE_LIST_DISMISSED

A value indicating the user closed the case list.

Constant Value: "list_dismissed"

public static final String VALUE_CASE_LIST_LAUNCHED

A value indicating the user launched the case list.

Constant Value: "list_launched"

public static final String VALUE_CASE_LIST_LOADED

A value indicating the case list loaded successfully.

Constant Value: "list_loaded"

public static final String VALUE_CASE_OPERATION_FAILURE

A value indicating an operation failed.

Constant Value: "failure"

public static final String VALUE_CASE_OPERATION_SUCCESS

A value indicating an operation completed successfully.

Constant Value: "success"

public static final String VALUE_CASE_PUBLISHER_DISMISSED

A value indicating the user closed the case publisher.

Constant Value: "publisher_dismissed"

public static final String VALUE_CASE_PUBLISHER_LAUNCHED

A value indicating the user launched the case publisher.

Constant Value: "publisher_launched"

public static final String VALUE_CASE_PUBLISHER_LOADED

A value indicating the case publisher completed loading.

Constant Value: "publisher_loaded"

public static final String VALUE_CASE_SUBMIT_COMPLETE

A value indicating user case submission completed successfully.

Constant Value: "submit_complete"

public static final String VALUE_CASE_SUBMIT_STARTED

A value indicating the user submitted a new case.

Constant Value: "submit_started"

public static final String VALUE_CASE_USER_TYPE_AUTHENTICATED

A value indicating the user has logged into a community or org.

Constant Value: "authenticated"

public static final String VALUE_CASE_USER_TYPE_GUEST

A value indicating the user has not logged in.

Constant Value: "guest"

Public Constructors

public CasesUIAnalytics ()