oracle.cloud.mobile.analytics

Class Analytics

java.lang.Object

ServiceProxy

oracle.cloud.mobile.analytics.Analytics

public final class Analytics
extends ServiceProxy

This class provides an interface to Oracle Mobile Cloud Analytics service. The most common use case is getting an instance of this class and logging one or more events through Analytics.logEvent(Event) or Analytics.logEvent(String) and flushing it through Analytics.flush() to the server.Analytics.flush() can cache analytics events when offline and automatically upload them to OMCe's Analytics collector when returning online. The samples below show how to get an instance of this class and log an event using different logging methods :

 Sample code using Analytics.logEvent(String) api
 
   try {
       Analytics mAnalyticsAgent = MobileBackendManager.getManager().getDefaultMobileBackend(MainActivity.this).getServiceProxy(Analytics.class);
       mAnalyticsAgent.logEvent("Mobile SDK Event");
       mAnalyticsAgent.flush();
     } catch (ServiceProxyException e) {
     }
 

 Sample code using Analytics.logEvent(Event) api
 
   try {
       Analytics mAnalyticsAgent = MobileBackendManager.getManager().getDefaultMobileBackend(MainActivity.this).getServiceProxy(Analytics.class);
       Map map = new HashMap();
       map.put("customEventPropertyKey", "customEventPropertyValue");

       Event event = new Event("Mobile SDK Event", new Date(), map);
       mAnalyticsAgent.logEvent(event);
       mAnalyticsAgent.flush();
     } catch (ServiceProxyException e) {
     }
 

 

Constructor Summary

Constructors

Constructor and Description
Analytics() This is the default constructor.

Method Summary

Modifier and Type	Method and Description
void	endSession(Context ctx) Stops the current Analytics session.
void	flush() Uploads all the logged events to the Analytics collector.
Event	logEvent(Event event) Adds the existing event to the list of events.
Event	logEvent(java.lang.String name) This method logs an Analytics event with the specified name.
void	postAnalyticsData()
void	setContextLocation(java.lang.String mCountry, java.lang.String mRegion, java.lang.String mLocality, java.lang.String mPostalCode) Provides optional functionality for mobile application developers to add Location-related attributes to the Context event in regions where reverse geocoding data is not available in the cloud due to data or privacy restrictions.
void	startSession(Context ctx) Starts an Analytics session which represents a series of interactions between client and server during the span of a single connection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Analytics

public Analytics()

This is the default constructor. Analytics is a singleton class and this constructor can not be called directly. An instance of this class can be obtained using the sample code below:

 
   try {
       Analytics mAnalyticsAgent = MobileBackendManager.getManager().getDefaultMobileBackend(MainActivity.this).getServiceProxy(Analytics.class);
     } catch (ServiceProxyException e) {
     }
 
 

Method Detail

startSession

public void startSession(Context ctx)

Starts an Analytics session which represents a series of interactions between client and server during the span of a single connection. If a session is already in progress, it simply proceeds and a new session is not started.

Parameters:

ctx - Application/Activity Context

endSession

public void endSession(Context ctx)

Stops the current Analytics session. Does nothing if a session is not in progress.

Parameters:

ctx - Application/Activity Context

flush

public void flush()

Uploads all the logged events to the Analytics collector. It can cache logged analytics events when offline and automatically upload them to the Analytics collector when returning online.

logEvent

public Event logEvent(java.lang.String name)

This method logs an Analytics event with the specified name. If an analytics session (which holds session information like ID, start time, end time etc.) is not in progress, it will start a session and then copy the specified event name before returning. This will not push the event to the server. An explicit call to Analytics.flush() is needed to push the logged event to server.

Parameters:

name - Name of the Event String

setContextLocation

public void setContextLocation(java.lang.String mCountry,
                               java.lang.String mRegion,
                               java.lang.String mLocality,
                               java.lang.String mPostalCode)

Provides optional functionality for mobile application developers to add Location-related attributes to the Context event in regions where reverse geocoding data is not available in the cloud due to data or privacy restrictions. Typically when custom analytic events are raised, the SDK captures the user's latitude/longitude and when posted to OMCe, the server translates that latitude/longitude to country/region/locality/postal code. There are some locations in the world where OMCe can't reverse geo-code Latitude/Longitude in the cloud due to data or privacy restrictions. Therefore, you must instead call this method to set the country, region, locality, and postal code explicitly on the client side.

Parameters:

mCountry - String Country name

mRegion - String Region name

mLocality - String Location name

mPostalCode - String ZIP code

logEvent

public Event logEvent(Event event)

Adds the existing event to the list of events. This will not push the event to the server. An explicit call to Analytics.flush() is needed to push the logged event to server.

Parameters:

event - Event object Event

postAnalyticsData

public void postAnalyticsData()