| java.lang.Object | |
| ↳ | com.mapsted.positioning.AnalyticsImpl |
Class Overview
Mapsted Analytics API is the public API for logging mobile analytics data in the positioning SDK.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | AnalyticsImpl.AnalyticsBundleBuilder | ||||||||||
| class | AnalyticsImpl.SearchData | ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void |
addMapAnalyticsEvent(ISearchable iSearchable, MapAnalyticsActionType actionType)
Notify of a map-interaction event
| ||||||||||
| void |
addMarketingAnalyticsEvent(String campaignId, MarketingEventType eventType, MarketingInteractionType interactionType)
Notify of a marketing analytics event
| ||||||||||
| void |
addSearchEvent(String searchBarId, String searchString, String selectedString, AnalyticsBundleContent bundle)
Notify that a search event occured
| ||||||||||
| int | getAnalyticsCollectionMode() | ||||||||||
| boolean |
getLocationLoggingStatus()
Get the current status of whether or not to log position analytics data for real-time analytics
| ||||||||||
| void |
setAnalyticsCollectionMode(int collectionMode)
Set up the analytics mode.
| ||||||||||
| void |
setLocationLogging(boolean enable)
Set up whether or not to log position analytics data for real-time analytics
| ||||||||||
| void |
updateScreen(String currentScreen)
Notify that a screen change occurred
| ||||||||||
| void |
updateScreen(String currentScreen, AnalyticsBundleContent bundleContent)
Notify that a screen change occurred
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
com.mapsted.positioning.CoreApi.Analytics
| |||||||||||
Public Methods
public void addMapAnalyticsEvent (ISearchable iSearchable, MapAnalyticsActionType actionType)
Notify of a map-interaction event
Parameters
| iSearchable | item that the user interacted with (e.g., selected entity or tag) |
|---|---|
| actionType | the action that was taken |
public void addMarketingAnalyticsEvent (String campaignId, MarketingEventType eventType, MarketingInteractionType interactionType)
Notify of a marketing analytics event
Parameters
| campaignId | identifying the campaign |
|---|---|
| eventType | the type of event shown (e.g., popup, push notification) |
| interactionType | how the user interacted with the event |
public void addSearchEvent (String searchBarId, String searchString, String selectedString, AnalyticsBundleContent bundle)
Notify that a search event occured
Parameters
| searchBarId | identifying string for the search bar used (e.g., screen or screen location) |
|---|---|
| searchString | the string that the user typed in |
| selectedString | the string of the item that was selected (if they selected an item) |
public int getAnalyticsCollectionMode ()
public boolean getLocationLoggingStatus ()
Get the current status of whether or not to log position analytics data for real-time analytics
Returns
- whether enabled or disabled
public void setAnalyticsCollectionMode (int collectionMode)
Set up the analytics mode.
The default mode is analytics on. There are three modes in total: analytics on, analytics off, and analytics on only when wifi is on.
Parameters
| collectionMode | The analytics mode you want to set. |
|---|
public void setLocationLogging (boolean enable)
Set up whether or not to log position analytics data for real-time analytics
Parameters
| enable | whether to enable or disable |
|---|
public void updateScreen (String currentScreen)
Notify that a screen change occurred
Parameters
| currentScreen | identifying string for the new screen |
|---|
public void updateScreen (String currentScreen, AnalyticsBundleContent bundleContent)
Notify that a screen change occurred
Parameters
| currentScreen | identifying string for the new screen |
|---|---|
| bundleContent | optional bundle content to indicate more specifics regarding screen (e.g., selected item or filtered by categories) |