com.adobe.mobile

Class Analytics

java.lang.Object

com.adobe.mobile.Analytics

public final class Analytics
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Analytics.BEACON_PROXIMITY
static interface	Analytics.TimedActionBlock<Boolean>

Constructor Summary

Constructors

Constructor and Description
Analytics()

Method Summary

Modifier and Type	Method and Description
static void	clearBeacon()
static void	clearQueue()
static long	getQueueSize()
static java.lang.String	getTrackingIdentifier()
static void	processReferrer(Context context, Intent intent)
static void	sendQueuedHits()
static void	trackAction(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> contextData)
static void	trackBeacon(java.lang.String uuid, java.lang.String major, java.lang.String minor, Analytics.BEACON_PROXIMITY proximity, java.util.Map<java.lang.String,java.lang.Object> contextData)
static boolean	trackingTimedActionExists(java.lang.String action)
static void	trackLifetimeValueIncrease(java.math.BigDecimal amount, java.util.HashMap<java.lang.String,java.lang.Object> contextData)
static void	trackLocation(Location location, java.util.Map<java.lang.String,java.lang.Object> contextData)
static void	trackState(java.lang.String state, java.util.Map<java.lang.String,java.lang.Object> contextData)
static void	trackTimedActionEnd(java.lang.String action, Analytics.TimedActionBlock<java.lang.Boolean> logic)
static void	trackTimedActionStart(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> contextData)
static void	trackTimedActionUpdate(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> contextData)

Methods inherited from class java.lang.Object

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

Constructor Detail

Analytics

public Analytics()

Method Detail

trackState

public static void trackState(java.lang.String state,
                              java.util.Map<java.lang.String,java.lang.Object> contextData)

trackAction

public static void trackAction(java.lang.String action,
                               java.util.Map<java.lang.String,java.lang.Object> contextData)

trackLocation

public static void trackLocation(Location location,
                                 java.util.Map<java.lang.String,java.lang.Object> contextData)

trackBeacon

public static void trackBeacon(java.lang.String uuid,
                               java.lang.String major,
                               java.lang.String minor,
                               Analytics.BEACON_PROXIMITY proximity,
                               java.util.Map<java.lang.String,java.lang.Object> contextData)

clearBeacon

public static void clearBeacon()

trackLifetimeValueIncrease

public static void trackLifetimeValueIncrease(java.math.BigDecimal amount,
                                              java.util.HashMap<java.lang.String,java.lang.Object> contextData)

trackTimedActionStart

public static void trackTimedActionStart(java.lang.String action,
                                         java.util.Map<java.lang.String,java.lang.Object> contextData)

Parameters:

action - a required String that denotes the name of the timed action to track.

contextData - optional HashMap containing context data to track with this timed action.

Attention

If a timed action with the same name already exists it will be deleted and a new one will replace it.

Brief

Tracks the start of a timed action

Note

This method does not send a tracking hit

trackTimedActionUpdate

public static void trackTimedActionUpdate(java.lang.String action,
                                          java.util.Map<java.lang.String,java.lang.Object> contextData)

Parameters:

action - a required String that denotes the name of the timed action to track.

contextData - optional HashMap containing context data to track with this timed action.

Attention

When the timed action is updated the contents of the parameter data will overwrite existing context data keys and append new ones.

Brief

Tracks the update of a timed action

Note

This method does not send a tracking hit

trackTimedActionEnd

public static void trackTimedActionEnd(java.lang.String action,
                                       Analytics.TimedActionBlock<java.lang.Boolean> logic)

Parameters:

action - a required String that denotes the name of the timed action to finish tracking.

logic - optional TimedActionBlock to perform logic and update parameters when this timed action ends, this block can cancel the sending of the hit by returning NO.

See Also:

Analytics.TimedActionBlock

Brief

Tracks the end of a timed action

Note

This method will send a tracking hit if the parameter logic is nil or returns YES. Valid values for inAppDuration and totalDuration are non-negative and fewer than the number of seconds in a year. If the value returned is negative, it is considered corrupt and will be ignored.

trackingTimedActionExists

public static boolean trackingTimedActionExists(java.lang.String action)

Parameters:

action - a required String that denotes the name of the timed action to check for.

Returns:

boolean indicating if the named action exists

Brief

Checks to see if a timed action exists

processReferrer

public static void processReferrer(Context context,
                                   Intent intent)

Parameters:

context - a required Context to be forwarded from your BroadcastReceiver.

intent - a required Intent to be forwarded from your BroadcastReceiver.

Brief

Processes referrer campaign data from the Google Play Store for later use.

Note

This method does not send a tracking hit.

getTrackingIdentifier

public static java.lang.String getTrackingIdentifier()

Brief

Retrieves identifier generated by analytics for this app/devince instance WARNING - this call will block the thread it is being called from and wait for a return.

getQueueSize

public static long getQueueSize()

Returns:

long WARNING - this call will block the thread it is being called from and wait for a return.

Brief

Returns the total number of hits currently in the queue

clearQueue

public static void clearQueue()

Brief

removes all unsent hits from the queue

sendQueuedHits

public static void sendQueuedHits()

Brief

sends all queued hits