Package com.batch.android.localcampaigns

Interface ViewTracker

All Known Implementing Classes:

LocalCampaignsSQLTracker, LocalCampaignsTracker

public interface ViewTracker

Interface that defines a Local Campaign view tracker.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ViewTracker.CountedViewEvent

Field Summary

Fields

Modifier and Type	Field	Description
static int	KIND_VIEW

Method Summary

Modifier and Type	Method	Description
long	campaignLastOccurrence(java.lang.String campaignId)	Track how much time has passed since the last view of a campaign
int	getNumberOfViewEventsSince(long timestamp)	Get the number of view event tracked since a given timestamp
java.util.Map<java.lang.String,java.lang.Integer>	getViewCounts(java.util.List<java.lang.String> campaignsIds)	Tell how many times have campaigns been seen
ViewTracker.CountedViewEvent	getViewEvent(java.lang.String campaignId)	Get the counted view events for a given campaign ID
ViewTracker.CountedViewEvent	trackViewEvent(java.lang.String campaignID)	Track a view

Field Detail

KIND_VIEW

static final int KIND_VIEW

See Also:

Constant Field Values

Method Detail

trackViewEvent

ViewTracker.CountedViewEvent trackViewEvent(@NonNull
                                            java.lang.String campaignID)
                                     throws ViewTrackerUnavailableException

Track a view

Parameters:

campaignID -

Throws:

ViewTrackerUnavailableException

getViewEvent

@NonNull
ViewTracker.CountedViewEvent getViewEvent(@NonNull
                                          java.lang.String campaignId)
                                   throws ViewTrackerUnavailableException

Get the counted view events for a given campaign ID

Throws:

ViewTrackerUnavailableException

getViewCounts

@NonNull
java.util.Map<java.lang.String,java.lang.Integer> getViewCounts(@NonNull
                                                                      java.util.List<java.lang.String> campaignsIds)
                                                               throws ViewTrackerUnavailableException

Tell how many times have campaigns been seen

Parameters:

campaignsIds - A list containing the ids

Returns:

Map Campaign id -> View counter

Throws:

ViewTrackerUnavailableException

campaignLastOccurrence

long campaignLastOccurrence(@NonNull
                            java.lang.String campaignId)
                     throws ViewTrackerUnavailableException

Track how much time has passed since the last view of a campaign

Parameters:

campaignId -

Returns:

The difference, measured in milliseconds, between the last occurence and midnight, January 1, 1970 UTC

Throws:

ViewTrackerUnavailableException

getNumberOfViewEventsSince

int getNumberOfViewEventsSince(long timestamp)
                        throws ViewTrackerUnavailableException

Get the number of view event tracked since a given timestamp

Parameters:

timestamp - date (timestamp in ms)

Returns:

total view events since the given date

Throws:

ViewTrackerUnavailableException - exception