IORABaseDataCollector Interface Reference

Inherited by ORABaseDataCollector.

Public Member Functions
void	scheduleSend ()
void	scheduleSendAll ()
void	pauseEventTransmission ()
void	resumeEventTransmission ()
boolean	isRunning ()
int	getEventsCount ()
Future< String >	appendSessionParamsToUrlAsync (final String url)
String	appendSessionParamsToUrl (final String url)
void	setSessionInfo (Activity activity)

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

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.

Implemented in ORABaseDataCollector.

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

Implemented in ORABaseDataCollector.

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

Implemented in ORABaseDataCollector.

isRunning()

boolean isRunning ( )

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

Implemented in ORABaseDataCollector.

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.

Implemented in ORABaseDataCollector.

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.

Implemented in ORABaseDataCollector.

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.

Implemented in ORABaseDataCollector.

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.

Implemented in ORABaseDataCollector.

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.

Implemented in ORABaseDataCollector.

 

The documentation for this interface was generated from the following file:

• IORABaseDataCollector.java