| java.lang.Object | |
| ↳ | com.salesforce.android.knowledge.ui.KnowledgeUIAnalytics |
Class Overview
KnowledgeUIAnalytics 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 Map object. Each map key is enumerated here to represent a behavior
in the Knowledge 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 Knowledge UI. |
| RESPONSE_ | Events that are triggered as a response to user interaction with the Knowledge UI. |
| DATA_ | Map Keys for the Event Data, which provide contextual information regarding an analytics event. |
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | DATA_ARTICLE_ID | The unique identifier for a Knowledge Article. | |||||||||
| String | DATA_ARTICLE_TITLE | The title of a Knowledge Article. | |||||||||
| String | DATA_CATEGORY_GROUP_NAME | The Data Category Group Name that Knowledge has been configured with. | |||||||||
| String | DATA_CATEGORY_LABEL | The display label for a Category. | |||||||||
| String | DATA_CATEGORY_NAME | The unique name that identifies a Category. | |||||||||
| String | DATA_COMMUNITY_URL | The Community URL that Knowledge has been configured with. | |||||||||
| String | DATA_IS_CORE_CLIENT_PROVIDED | Whether or not a pre-initialized KnowledgeCore client instance has been provided to Knowledge UI by your application. | |||||||||
| String | DATA_IS_IMAGE_PROVIDER_PRESENT | Whether or not a KnowledgeImageProvider implementation has been provided to Knowledge UI. | |||||||||
| String | DATA_KNOWLEDGE_FROM_SCENE | The KnowledgeScene we are navigating away from. | |||||||||
| String | DATA_KNOWLEDGE_TO_SCENE | The KnowledgeScene we are navigating into. | |||||||||
| String | DATA_ROOT_CATEGORY_NAME | The Root Data Category Name that Knowledge UI has been configured with. | |||||||||
| String | DATA_SEARCH_TERM | The search term that has been entered by the user. | |||||||||
| String | RESPONSE_CLOSED | The Knowledge UI has been closed. | |||||||||
| String | RESPONSE_COLLAPSED_CATEGORY_HEADER | A category summary on the Support Home view has been hidden. | |||||||||
| String | RESPONSE_EXPANDED_CATEGORY_HEADER | A category summary on the Support Home view has been displayed. | |||||||||
| String | RESPONSE_INITIALIZED_CLIENT | The Knowledge UI has been successfully initialized. | |||||||||
| String | RESPONSE_LAUNCHED | The Knowledge UI has been launched. | |||||||||
| String | RESPONSE_LOADED_ARTICLE_DETAIL_VIEW | The Article Detail view has been loaded and is displaying the content of a Knowledge Article. | |||||||||
| String | RESPONSE_LOADED_ARTICLE_LIST_VIEW | The Article List view has been loaded. | |||||||||
| String | RESPONSE_LOADED_CATEGORY_DETAIL_VIEW | The Category Detail view has been loaded. | |||||||||
| String | RESPONSE_LOADED_MORE_ARTICLES | Additional articles have been loaded into the Article List view. | |||||||||
| String | RESPONSE_LOADED_SEARCH_RESULT | Search results based on the user's query have been loaded into the Search View. | |||||||||
| String | RESPONSE_LOADED_SEARCH_VIEW | The Search View has been loaded. | |||||||||
| String | RESPONSE_LOADED_SUPPORT_HOME_VIEW | The Support Home view has been loaded and is displaying the categories at the top of the Root Category. | |||||||||
| String | RESPONSE_MAXIMIZED | The previously minimized Knowledge article has been maximized. | |||||||||
| String | RESPONSE_MINIMIZED | A Knowledge article has been minimized. | |||||||||
| String | USER_CLEAR_SEARCH_TERM | The user has cleared the search term. | |||||||||
| String | USER_CLOSE | The Knowledge UI has been requested to close. | |||||||||
| String | USER_INITIALIZE_CLIENT | The Knowledge UI Client is now being initialized. | |||||||||
| String | USER_INPUT_SEARCH_TERM | The user has entered or modified the search term. | |||||||||
| String | USER_LAUNCH | The Knowledge UI has been requested to launchHome. | |||||||||
| String | USER_MAXIMIZE | The user has requested to maximize the previously minimized article. | |||||||||
| String | USER_MINIMIZE | The user has requested to minimize the current article. | |||||||||
| String | USER_MOVE_THUMBNAIL | The user has moved the thumbnail. | |||||||||
| String | USER_NAVIGATE_BACK | The user has navigated back by pressing the Back Button on the Android Navigation Bar or the App Toolbar. | |||||||||
| String | USER_SELECT_ARTICLE_DETAILS | The user has chosen to view the details of an article. | |||||||||
| String | USER_SELECT_ARTICLE_LIST | The user has chosen to view a list of articles within a category. | |||||||||
| String | USER_SELECT_CATEGORY_DETAIL | The user has chosen to view more details about a category. | |||||||||
| String | USER_SELECT_CATEGORY_HEADER | The user has selected a category header on the Support Home view. | |||||||||
| String | USER_SELECT_SEARCH_VIEW | The user has chosen to load the Search view. | |||||||||
| String | USER_SHOW_MORE_ARTICLES | The user has started loading more articles within the article list. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| KnowledgeUIAnalytics() | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final String DATA_ARTICLE_ID
The unique identifier for a Knowledge Article.
public static final String DATA_ARTICLE_TITLE
The title of a Knowledge Article.
public static final String DATA_CATEGORY_GROUP_NAME
The Data Category Group Name that Knowledge has been configured with.
public static final String DATA_CATEGORY_LABEL
The display label for a Category.
public static final String DATA_CATEGORY_NAME
The unique name that identifies a Category.
public static final String DATA_COMMUNITY_URL
The Community URL that Knowledge has been configured with.
public static final String DATA_IS_CORE_CLIENT_PROVIDED
Whether or not a pre-initialized KnowledgeCore client instance has been provided to Knowledge UI by your application.
public static final String DATA_IS_IMAGE_PROVIDER_PRESENT
Whether or not a KnowledgeImageProvider implementation has been provided to Knowledge UI.
public static final String DATA_KNOWLEDGE_FROM_SCENE
The KnowledgeScene we are navigating away from.
public static final String DATA_KNOWLEDGE_TO_SCENE
The KnowledgeScene we are navigating into.
public static final String DATA_ROOT_CATEGORY_NAME
The Root Data Category Name that Knowledge UI has been configured with.
public static final String DATA_SEARCH_TERM
The search term that has been entered by the user.
public static final String RESPONSE_CLOSED
The Knowledge UI has been closed.
public static final String RESPONSE_COLLAPSED_CATEGORY_HEADER
A category summary on the Support Home view has been hidden.
public static final String RESPONSE_EXPANDED_CATEGORY_HEADER
A category summary on the Support Home view has been displayed.
public static final String RESPONSE_INITIALIZED_CLIENT
The Knowledge UI has been successfully initialized.
public static final String RESPONSE_LAUNCHED
The Knowledge UI has been launched.
public static final String RESPONSE_LOADED_ARTICLE_DETAIL_VIEW
The Article Detail view has been loaded and is displaying the content of a Knowledge Article.
public static final String RESPONSE_LOADED_ARTICLE_LIST_VIEW
The Article List view has been loaded.
public static final String RESPONSE_LOADED_CATEGORY_DETAIL_VIEW
The Category Detail view has been loaded.
public static final String RESPONSE_LOADED_MORE_ARTICLES
Additional articles have been loaded into the Article List view.
public static final String RESPONSE_LOADED_SEARCH_RESULT
Search results based on the user's query have been loaded into the Search View.
public static final String RESPONSE_LOADED_SEARCH_VIEW
The Search View has been loaded.
public static final String RESPONSE_LOADED_SUPPORT_HOME_VIEW
The Support Home view has been loaded and is displaying the categories at the top of the Root Category.
public static final String RESPONSE_MAXIMIZED
The previously minimized Knowledge article has been maximized.
public static final String RESPONSE_MINIMIZED
A Knowledge article has been minimized.
public static final String USER_CLEAR_SEARCH_TERM
The user has cleared the search term.
public static final String USER_CLOSE
The Knowledge UI has been requested to close.
public static final String USER_INITIALIZE_CLIENT
The Knowledge UI Client is now being initialized.
public static final String USER_INPUT_SEARCH_TERM
The user has entered or modified the search term.
public static final String USER_LAUNCH
The Knowledge UI has been requested to launchHome.
public static final String USER_MAXIMIZE
The user has requested to maximize the previously minimized article.
public static final String USER_MINIMIZE
The user has requested to minimize the current article.
public static final String USER_MOVE_THUMBNAIL
The user has moved the thumbnail.
public static final String USER_NAVIGATE_BACK
The user has navigated back by pressing the Back Button on the Android Navigation Bar or the App Toolbar.
public static final String USER_SELECT_ARTICLE_DETAILS
The user has chosen to view the details of an article.
public static final String USER_SELECT_ARTICLE_LIST
The user has chosen to view a list of articles within a category. This event may occur by pressing the "Show More" button on the Support Home view for a category that does not have any sub-categories, or by pressing the "Show More Articles" button on the Category Details view.
public static final String USER_SELECT_CATEGORY_DETAIL
The user has chosen to view more details about a category. This event may occur by pressing the "Show More" button on the Support Home view for a category that has sub-categories.
public static final String USER_SELECT_CATEGORY_HEADER
The user has selected a category header on the Support Home view.
public static final String USER_SELECT_SEARCH_VIEW
The user has chosen to load the Search view.
public static final String USER_SHOW_MORE_ARTICLES
The user has started loading more articles within the article list.