Package com.batch.android.module

Class TrackerModule

java.lang.Object

com.batch.android.module.BatchModule

com.batch.android.module.TrackerModule

All Implemented Interfaces:

EventSender.EventSenderListener

public final class TrackerModule
extends BatchModule
implements EventSender.EventSenderListener

Event Tracker module of Batch

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TAG

Method Summary

Modifier and Type	Method	Description
void	batchDidStart()	Called by Batch right after batch start NB : Same context and activity that in willStart but with the new state State.READY set
void	batchDidStop()	Called by Batch right after batch stop NB : No context or activity are available
void	batchWillStart()	Called by Batch before batch start NB : Context & activity are already available from the runtimeManager
java.util.List<Event>	getEventsToSend()	Datasource method that should provide a list of events to send
java.lang.String	getId()	ID of the module
int	getState()	Should return the state of the module (usually 0 for deactivated, 1 for activated)
void	onEventsSendFailure(java.util.List<Event> events)	Called when events has failed to be sent to server
void	onEventsSendSuccess(java.util.List<Event> events)	Called when events has been sent to server
static TrackerModule	provide()
void	track(java.lang.String name)	Track an event by its name
void	track(java.lang.String name, long timestamp)	Track an event by its name and timestamp
void	track(java.lang.String name, long timestamp, JSONObject parameters)	Track en event by its name, timestamp and with additional parameters
void	track(java.lang.String name, JSONObject parameters)	Track an event by its name with additional parameters
void	trackCampaignView(java.lang.String campaignID, JSONObject eventData)	Track local campaign vien
void	trackCollapsible(java.lang.String name, long timestamp, JSONObject parameters)	Track a collapsible event by its name, timestamp and with additional parameters
void	wipeData(android.content.Context context)

Methods inherited from class com.batch.android.module.BatchModule

batchContextBecameAvailable, batchIsFinishing, batchWillStop

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Method Detail

provide

public static TrackerModule provide()

getId

public java.lang.String getId()

Description copied from class: BatchModule

ID of the module

Specified by:

getId in class BatchModule

Returns:

getState

public int getState()

Description copied from class: BatchModule

Should return the state of the module (usually 0 for deactivated, 1 for activated)

Specified by:

getState in class BatchModule

Returns:

batchWillStart

public void batchWillStart()

Description copied from class: BatchModule

Called by Batch before batch start
NB : Context & activity are already available from the runtimeManager

Overrides:

batchWillStart in class BatchModule

batchDidStart

public void batchDidStart()

Description copied from class: BatchModule

Called by Batch right after batch start
NB : Same context and activity that in willStart but with the new state State.READY set

Overrides:

batchDidStart in class BatchModule

batchDidStop

public void batchDidStop()

Description copied from class: BatchModule

Called by Batch right after batch stop
NB : No context or activity are available

Overrides:

batchDidStop in class BatchModule

track

public void track(java.lang.String name)

Track an event by its name

Parameters:

name -

track

public void track(java.lang.String name,
                  JSONObject parameters)

Track an event by its name with additional parameters

Parameters:

name -

parameters -

track

public void track(java.lang.String name,
                  long timestamp,
                  JSONObject parameters)

Track en event by its name, timestamp and with additional parameters

Parameters:

name -

timestamp -

parameters -

trackCollapsible

public void trackCollapsible(java.lang.String name,
                             long timestamp,
                             JSONObject parameters)

Track a collapsible event by its name, timestamp and with additional parameters

Parameters:

name -

timestamp -

parameters -

track

public void track(java.lang.String name,
                  long timestamp)

Track an event by its name and timestamp

Parameters:

name -

timestamp -

trackCampaignView

public void trackCampaignView(@NonNull
                              java.lang.String campaignID,
                              @NonNull
                              JSONObject eventData)

Track local campaign vien

Parameters:

campaignID -

eventData -

onEventsSendSuccess

public void onEventsSendSuccess(java.util.List<Event> events)

Description copied from interface: EventSender.EventSenderListener

Called when events has been sent to server

Specified by:

onEventsSendSuccess in interface EventSender.EventSenderListener

Parameters:

events - sent events

onEventsSendFailure

public void onEventsSendFailure(java.util.List<Event> events)

Description copied from interface: EventSender.EventSenderListener

Called when events has failed to be sent to server

Specified by:

onEventsSendFailure in interface EventSender.EventSenderListener

Parameters:

events - events not sent

getEventsToSend

public java.util.List<Event> getEventsToSend()

Description copied from interface: EventSender.EventSenderListener

Datasource method that should provide a list of events to send

Specified by:

getEventsToSend in interface EventSender.EventSenderListener

Returns:

an empty list if there's nothing to send (Should never return null!)

wipeData

public void wipeData(android.content.Context context)