ORABaseDataCollector Class Reference

Inherits IORABaseDataCollector, and IORAAppDataCollector.

Public Member Functions
boolean	isAppInForeground ()
Map< String, String >	triggerEvent (final ORAEventMap eventMap)
Map< String, String >	triggerEventImmediately (final ORAEventMap eventMap)
void	scheduleSend ()
void	scheduleSendAll ()
void	pauseEventTransmission ()
void	resumeEventTransmission ()
void	setSessionInfo (Activity activity)
Future< String >	appendSessionParamsToUrlAsync (final String url)
String	appendSessionParamsToUrl (final String url)
int	getEventsCount ()
boolean	isRunning ()
Map< String, String >	triggerApplicationStartEvent (final String applicationName, final Map< String, String > customData)
Map< String, String >	triggerApplicationEnterBackgroundEvent (final String applicationName, final Map< String, String > customData)
Map< String, String >	triggerApplicationEnterForegroundEvent (final String applicationName, final Map< String, String > customData)
Map< String, String >	triggerApplicationErrorEvent (final String applicationName, final String errorMessage, final Map< String, String > customData)
Map< String, String >	triggerApplicationTerminateEvent (final String applicationName, final Map< String, String > customData)
Map< String, String >	triggerActivityStartEvent (final String activityName, final Map< String, String > customData)
Map< String, String >	triggerActivityResumeEvent (final String activityName, final Map< String, String > customData)
Map< String, String >	triggerActivityPauseEvent (final String activityName, final Map< String, String > customData)
Map< String, String >	triggerActivityStopEvent (final String activityName, final Map< String, String > customData)
Map< String, String >	triggerFragmentStartEvent (final String activityName, final String fragmentName, final Map< String, String > customData)
Map< String, String >	triggerFragmentResumeEvent (final String activityName, final String fragmentName, final Map< String, String > customData)
Map< String, String >	triggerFragmentPauseEvent (final String activityName, final String fragmentName, final Map< String, String > customData)
Map< String, String >	triggerFragmentStopEvent (final String activityName, final String fragmentName, final Map< String, String > customData)
Map< String, String >	triggerNotificationEvent (final String activityName, final String notificationMessage, final Map< String, String > customData)
Map< String, String >	triggerCustomEvent (final ORAEventMeta eventMeta)
Map< String, String >	triggerScreenViewEvent (final ORAEventMeta eventMeta, final String contentGroup)
void	enableORAInWebView (final WebView webView)
boolean	addEventListener (IORAEventListener listener, @NonNull String moduleId, @NonNull String listenerName, List< String > groups, int priority)
boolean	removeEventListener (@NonNull String moduleId, @NonNull String listenerName)

Static Public Member Functions
static synchronized ORABaseDataCollector	getInstance (final Context context)
static synchronized ORABaseDataCollector	getInstance ()
static void	setApplication (final Application application)

Detailed Description

ORABaseDataCollector is the central class provided by Oracle Core Mobile SDK. Its central purpose is to log and send events to the Oracle Infinity collection servers. It's primarily accessed through its sharedCollector singleton. It should not be manually initialized.

Member Function Documentation

addEventListener()

boolean addEventListener	(	IORAEventListener	listener,
		@NonNull String	moduleId,
		@NonNull String	listenerName,
		List< String >	groups,
		int	priority
	)

Adds an event listener

Parameters

• listener: An instance of the IORAEventListener interface which will be triggered when event criteria match.
• moduleId: unique identifier for the module.
• listenerName: A unique name for the Listener.
• groups: Event groups that the module wants to subscribe for. Below are the groups defined in Core SDK.
• priority: Priority in which core has to trigger the observer.

Returns

true if listener added successfully

appendSessionParamsToUrl()

String appendSessionParamsToUrl ( final String url )

A helper method to append the session parameters to the URL of the embedded web content. These parameters are parsed by the JavaScript plug-in in the embedded content and used to configure its user ID and session configuration. This method is not necessary when using the openUrl() method, which appends session parameters itself.

Parameters

url	The String destination URL that the WebView will open. Session parameters will be appended to the URL in a query string.

Returns

the String URL with session parameters appended.

Implements IORABaseDataCollector.

appendSessionParamsToUrlAsync()

Future<String> appendSessionParamsToUrlAsync ( final String url )

Appends session params to url asynchronously

Parameters

• url to append session params as query params

Returns

Future string

Implements IORABaseDataCollector.

enableORAInWebView()

void enableORAInWebView ( final WebView webView )

Add ORA javascript interface to specified webView to enable communication of session data between the webView and the Oracle Infinity Mobile SDK.

Parameters

webView

The webView used in the hybrid application

Implements IORAAppDataCollector.

getEventsCount()

int getEventsCount ( )

Get the current event count, the number of events queued and ready to send to the data collection server.

Returns

int The number of events in the local data store

Implements IORABaseDataCollector.

getInstance() [1/2]

static synchronized ORABaseDataCollector getInstance ( final Context context )

Deprecated:This method is deprecated. Using this method will give issues in some scenarios. We are planning to remove this method in future releases.

Alternatively use getInstance()

Returns instance of ORABaseDataCollector

Parameters

context

application context

Returns

reference of ORABaseDataCollector

getInstance() [2/2]

static synchronized ORABaseDataCollector getInstance ( )

Returns instance of ORABaseDataCollector. Before calling this method, you need to create a class which extend from ORABaseApplication class and add its entry in the AndroidManifest file under application tag like below

<application
android:name="your class name which extends from ORABaseApplication"
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:theme="@style/AppTheme">
</application>

Or if you don't want to extend your class from ORABaseApplication, you call simply call setApplication(final Application application) method.

Returns

reference of ORABaseDataCollector

isAppInForeground()

boolean isAppInForeground ()

Returns state of the application

Returns

true 

if application in foreground, otherwise

false 

Implements IORAAppDataCollector.

isRunning()

boolean isRunning ()

Returns status of event sender, false - if event sender is paused and true - otherwise

Implements IORABaseDataCollector.

pauseEventTransmission()

void pauseEventTransmission ( )

Pause event transmission. Events will continue to collect in local storage, but they will not be transmitted to the Oracle data collection servers. If the number of events stored locally exceeds the value of ora_dc_event_table_size_maximum (max persisted events), then older events will be dropped as new ones are generated.

Implements IORABaseDataCollector.

removeEventListener()

boolean removeEventListener	(	@NonNull String	moduleId,
		@NonNull String	listenerName
	)

Removes the event listener if previously added.

Parameters

moduleId	A unique identifier for the module.
listenerName	A unique name given for the Listener.

Returnstrue if listener deleted successfully

resumeEventTransmission()

void resumeEventTransmission ( )

Resume event transmission. If event transmission is paused, it will now be resumed. This method also triggers an event send to be called, sending a batch of events to data collection.

Implements IORABaseDataCollector.

scheduleSend()

void scheduleSend ( )

Send a batch of events to the data collector. This will send one and only one batch. If the value of ora_dc_events_per_send is greater than the number of events stored locally, then all events in the local data store will be transmitted. Normal restrictions on sending events still apply such as battery life, wifi availability, etc.

Implements IORABaseDataCollector.

scheduleSendAll()

void scheduleSendAll ( )

Transmit all events in the local data store. If there are more events in the local data store than the size of ora_dc_events_per_send, then multiple send events will be triggered until the local event storage has been drained. Normal restrictions on sending events still apply such as battery life, wifi availability, etc.

Implements IORABaseDataCollector.

setApplication()

static void setApplication ( final Application application )

This should be called at the entry point of the application. This will initiate the data collection.

Also see getInstance()

Parameters

application

Android android.app.Application or its subclass reference

setSessionInfo()

void setSessionInfo ( Activity activity )

A convenience method that attaches hybrid session data to a hybrid activity. This method must be called to manually track events from a web page in a hybrid application. It sets the session start time, last event time, and visitor ID for the web session, which can be read and used by a web page tagged with the Oracle tag.Parameters

activity

The current activity containing a webView.

Implements IORABaseDataCollector.

triggerActivityPauseEvent()

Map<String, String> triggerActivityPauseEvent	(	final String	activityName,
		final Map< String, String >	customData
	)

Generate an Activity Pause event (Automatically generated when automatic events are enabled) When calling this method manually, it is recommended to place the call in the activity lifecycle such as in the Activity.onPause() method.

Parameters

activityName	Specifies an activity name associated with this event.
customData	Specifies a series of custom name-value parameters used to pass data that is not included in the method.

Returns

The collection of key/value pairs that make up the event (as a Map<String, String>). This may be discarded.

Example:

publicvoid onPause() {
// Create some custom data, but this is optional:
                                                                        
     Map<String, String> customData = new HashMap<String, String>();
     customData.put("foo", "bar");
     customData.put("boo", "baz");
// Create the activity pause event.
                                                                        
     ORADataCollector.getInstance().triggerActivityPauseEvent("My Activity", customData);
     super.onPause();
}

Oracle Infinity parameters included in this event:

• dcsuri: "/activity/pause"
• wt.ti: activityName
• wt.pi: activityName
• wt.dl: "61"
• wt.sys: "pause"

In addition to these, all events contain the following  Oracle Infinity params:

Device Parameters

• WT.ets: Epoch Time Stamp, set at event creation time 
• WT.co: Set Cookie on Redirect, always "yes" 
• WT.dm: Device Model, set by accessing \c android.os.Build.model and \c BUILD.manufacturer properties or "unknown" 
• WT.os: Operating System Version, reported by android.os.Build.VERSION.RELEASE or "unknown" 
• WT.av: Application Version, set by the wt_dc_app_version config setting or context.getPackageName() 
• WT.a_nm: Application Name, set by the wt_dc_app_name config setting or context.getApplicationInfo().labelRes 
• WT.a_dc: Data Carrier, set by Context.TELEPHONY_SERVICE 
• WT.ul: Locale Language, set by Locale.getDefault().getDisplayLanguage() 
• WT.uc: Locale Country, set by Locale.getDefault().getDisplayCountry() 
• WT.sr: Screen Resolution, set by context.getSystemService(Context.WINDOW_SERVICE).getDefaultDisplay().getMetrics() 
• WT.sdk_v: SDK Version, set by BuildConfig.VERSION_NAME 
• WT.ct: Connection Type,set by the CONNECTIVITY_SERVICE getActiveNetworkInfo() 
• WT.g_co: Country Code, set by the TELEPHONY_SERVICE getNetworkCountryIso() 
• WT.d_id: Unique ID, set by randomly generated ID(only included if the wt_dc_send_unique_id_enabled : config setting is set to true) 
• WT.i_ornt: Interface Orientation, set by the Display.getOrientation() method 
• WT.g_long: Geographic Location: longitude, set by the location.getLongitude() method 
• WT.g_lat: Geographic Location: latitude, set by the location.getLatitude() method 
• WT.gc: Geographic Location: A concatenation of WT.g_lat and WT.g_long, joined with a ","
• user-agent: User agent string, set by System.getProperty("http.agent")

Session Parameters

• WT.vtvs: Session Start, the start time of the current session 
• WT.co_f: Visitor ID, the unique visitor ID assigned to this session 
• WT.vt_sid: VisitorID.SessionStart, a concatenation of WT.co_f and WT.vtvs, joined with a "." 
• WT.vtid: Visitor ID, the unique visitor ID assigned to this session 
• WT.vt_f: First hit ever for this visitor, "1" if true, "0" if false 
• WT.vt_f_s: First hit of the session for this visitor, "1" if true, "0" if false 
• WT.vt_f_tlh: Time of last hit 

Note: This method is called automatically when automatics are turned on (setting ora_dc_automatics_enabled = true). Automatic methods will be called without any custom params.

Implements IORAAppDataCollector.