Package com.batch.android.module

Class UserModule

java.lang.Object

com.batch.android.module.BatchModule

com.batch.android.module.UserModule

public final class UserModule
extends BatchModule

Batch User module

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserModule.SaveException

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PARAMETER_KEY_AMOUNT
static java.lang.String	PARAMETER_KEY_DATA
static java.lang.String	PARAMETER_KEY_LABEL
static java.lang.String	TAG

Method Summary

Modifier and Type	Method	Description
protected boolean	_trackEvent(java.lang.String name, JSONObject params)
static void	addUserPendingOperations(java.util.List<UserOperation> operations)	Add pending operations when BatchUserDataEditor.save() is called before the SDK is started
static void	applyUserOperationsSync(java.util.List<UserOperation> pendingOperationQueue)
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	bumpVersion(long serverVersion)
java.lang.String	getId()	ID of the module
int	getState()	Should return the state of the module (usually 0 for deactivated, 1 for activated)
static void	printDebugInfo()
static UserModule	provide()
void	startCheckWS(long msDelay)
void	startSendWS(long msDelay)
void	storeTransactionID(java.lang.String transactionID, long version)
static void	submitOnApplyQueue(long msDelay, java.lang.Runnable r)
void	trackLocation(android.location.Location location)
void	trackPublicEvent(java.lang.String event, java.lang.String label, JSONObject data)	Track a public event
void	trackTransaction(double amount, JSONObject data)
static void	userOptedIn(android.content.Context context)
static void	wipeData(android.content.Context context)

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

batchContextBecameAvailable, batchDidStop, batchIsFinishing, batchWillStart, 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

PARAMETER_KEY_LABEL

public static final java.lang.String PARAMETER_KEY_LABEL

See Also:

Constant Field Values

PARAMETER_KEY_DATA

public static final java.lang.String PARAMETER_KEY_DATA

See Also:

Constant Field Values

PARAMETER_KEY_AMOUNT

public static final java.lang.String PARAMETER_KEY_AMOUNT

See Also:

Constant Field Values

Method Detail

provide

public static UserModule 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:

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

startSendWS

public void startSendWS(long msDelay)

startCheckWS

public void startCheckWS(long msDelay)

storeTransactionID

public void storeTransactionID(java.lang.String transactionID,
                               long version)

bumpVersion

public void bumpVersion(long serverVersion)

trackPublicEvent

public void trackPublicEvent(java.lang.String event,
                             java.lang.String label,
                             JSONObject data)

Track a public event

Parameters:

event - Event name

label - Event label

data - Event data, expected to already be converted from BatchEventData.

_trackEvent

protected boolean _trackEvent(java.lang.String name,
                              JSONObject params)

trackLocation

public void trackLocation(android.location.Location location)

trackTransaction

public void trackTransaction(double amount,
                             JSONObject data)

submitOnApplyQueue

public static void submitOnApplyQueue(long msDelay,
                                      java.lang.Runnable r)

addUserPendingOperations

public static void addUserPendingOperations(java.util.List<UserOperation> operations)

Add pending operations when BatchUserDataEditor.save() is called before the SDK is started

Parameters:

operations -

applyUserOperationsSync

public static void applyUserOperationsSync(java.util.List<UserOperation> pendingOperationQueue)
                                    throws UserModule.SaveException

Throws:

UserModule.SaveException

printDebugInfo

public static void printDebugInfo()

wipeData

public static void wipeData(android.content.Context context)

userOptedIn

public static void userOptedIn(android.content.Context context)