com.amplitude.api

Class AmplitudeClient

java.lang.Object

com.amplitude.api.AmplitudeClient

Direct Known Subclasses:

PinnedAmplitudeClient

public class AmplitudeClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	apiKey
protected android.content.Context	context
static java.lang.String	DEVICE_ID_KEY
protected java.lang.String	deviceId
static java.lang.String	END_SESSION_EVENT
protected static AmplitudeClient	instance
static java.lang.String	REVENUE_EVENT
static java.lang.String	START_SESSION_EVENT
static java.lang.String	TAG
protected java.lang.String	userId

Constructor Summary

Constructors

Constructor and Description
AmplitudeClient()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	bytesToHexString(byte[] bytes)
protected boolean	contextAndApiKeySet(java.lang.String methodName)
AmplitudeClient	disableLocationListening()
AmplitudeClient	enableForegroundTracking(android.app.Application app)
AmplitudeClient	enableLocationListening()
AmplitudeClient	enableNewDeviceIdPerInstall(boolean newDeviceIdPerInstall)
java.lang.String	getDeviceId()
static AmplitudeClient	getInstance()
protected java.lang.String	getSharedPreferencesName()
java.lang.String	getUserId()
AmplitudeClient	initialize(android.content.Context context, java.lang.String apiKey)
AmplitudeClient	initialize(android.content.Context context, java.lang.String apiKey, java.lang.String userId)
void	logEvent(java.lang.String eventType)
void	logEvent(java.lang.String eventType, org.json.JSONObject eventProperties)
void	logEvent(java.lang.String eventType, org.json.JSONObject eventProperties, boolean outOfSession)
protected long	logEvent(java.lang.String eventType, org.json.JSONObject eventProperties, org.json.JSONObject apiProperties, long timestamp, boolean outOfSession)
protected void	logEventAsync(java.lang.String eventType, org.json.JSONObject eventProperties, org.json.JSONObject apiProperties, long timestamp, boolean outOfSession)
void	logEventSync(java.lang.String eventType, org.json.JSONObject eventProperties)
void	logRevenue(double amount)
void	logRevenue(java.lang.String productId, int quantity, double price)
void	logRevenue(java.lang.String productId, int quantity, double price, java.lang.String receipt, java.lang.String receiptSignature)
protected void	makeEventUploadPostRequest(com.squareup.okhttp.OkHttpClient client, java.lang.String events, long maxId)
protected java.lang.Object	replaceWithJSONNull(java.lang.Object obj)
protected long	saveEvent(org.json.JSONObject event)
AmplitudeClient	setEventMaxCount(int eventMaxCount)
AmplitudeClient	setEventUploadMaxBatchSize(int eventUploadMaxBatchSize)
AmplitudeClient	setEventUploadPeriodMillis(int eventUploadPeriodMillis)
AmplitudeClient	setEventUploadThreshold(int eventUploadThreshold)
AmplitudeClient	setMinTimeBetweenSessionsMillis(long minTimeBetweenSessionsMillis)
AmplitudeClient	setOffline(boolean offline)
AmplitudeClient	setOptOut(boolean optOut)
AmplitudeClient	setSessionTimeoutMillis(long sessionTimeoutMillis)
void	setUserId(java.lang.String userId)
void	setUserProperties(org.json.JSONObject userProperties)
void	setUserProperties(org.json.JSONObject userProperties, boolean replace)
AmplitudeClient	trackSessionEvents(boolean trackingSessionEvents)
protected void	updateServer()
protected void	updateServer(boolean limit)
void	uploadEvents()
AmplitudeClient	useAdvertisingIdForDeviceId()
protected boolean	validateLogEvent(java.lang.String eventType)

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

START_SESSION_EVENT

public static final java.lang.String START_SESSION_EVENT

See Also:

Constant Field Values

END_SESSION_EVENT

public static final java.lang.String END_SESSION_EVENT

See Also:

Constant Field Values

REVENUE_EVENT

public static final java.lang.String REVENUE_EVENT

See Also:

Constant Field Values

DEVICE_ID_KEY

public static final java.lang.String DEVICE_ID_KEY

See Also:

Constant Field Values

instance

protected static AmplitudeClient instance

context

protected android.content.Context context

apiKey

protected java.lang.String apiKey

userId

protected java.lang.String userId

deviceId

protected java.lang.String deviceId

Constructor Detail

AmplitudeClient

public AmplitudeClient()

Method Detail

getInstance

public static AmplitudeClient getInstance()

initialize

public AmplitudeClient initialize(android.content.Context context,
                         java.lang.String apiKey)

initialize

public AmplitudeClient initialize(android.content.Context context,
                         java.lang.String apiKey,
                         java.lang.String userId)

enableForegroundTracking

public AmplitudeClient enableForegroundTracking(android.app.Application app)

enableNewDeviceIdPerInstall

public AmplitudeClient enableNewDeviceIdPerInstall(boolean newDeviceIdPerInstall)

useAdvertisingIdForDeviceId

public AmplitudeClient useAdvertisingIdForDeviceId()

enableLocationListening

public AmplitudeClient enableLocationListening()

disableLocationListening

public AmplitudeClient disableLocationListening()

setEventUploadThreshold

public AmplitudeClient setEventUploadThreshold(int eventUploadThreshold)

setEventUploadMaxBatchSize

public AmplitudeClient setEventUploadMaxBatchSize(int eventUploadMaxBatchSize)

setEventMaxCount

public AmplitudeClient setEventMaxCount(int eventMaxCount)

setEventUploadPeriodMillis

public AmplitudeClient setEventUploadPeriodMillis(int eventUploadPeriodMillis)

setMinTimeBetweenSessionsMillis

public AmplitudeClient setMinTimeBetweenSessionsMillis(long minTimeBetweenSessionsMillis)

setSessionTimeoutMillis

public AmplitudeClient setSessionTimeoutMillis(long sessionTimeoutMillis)

setOptOut

public AmplitudeClient setOptOut(boolean optOut)

setOffline

public AmplitudeClient setOffline(boolean offline)

trackSessionEvents

public AmplitudeClient trackSessionEvents(boolean trackingSessionEvents)

logEvent

public void logEvent(java.lang.String eventType)

logEvent

public void logEvent(java.lang.String eventType,
            org.json.JSONObject eventProperties)

logEvent

public void logEvent(java.lang.String eventType,
            org.json.JSONObject eventProperties,
            boolean outOfSession)

logEventSync

public void logEventSync(java.lang.String eventType,
                org.json.JSONObject eventProperties)

validateLogEvent

protected boolean validateLogEvent(java.lang.String eventType)

logEventAsync

protected void logEventAsync(java.lang.String eventType,
                 org.json.JSONObject eventProperties,
                 org.json.JSONObject apiProperties,
                 long timestamp,
                 boolean outOfSession)

logEvent

protected long logEvent(java.lang.String eventType,
            org.json.JSONObject eventProperties,
            org.json.JSONObject apiProperties,
            long timestamp,
            boolean outOfSession)

saveEvent

protected long saveEvent(org.json.JSONObject event)

logRevenue

public void logRevenue(double amount)

logRevenue

public void logRevenue(java.lang.String productId,
              int quantity,
              double price)

logRevenue

public void logRevenue(java.lang.String productId,
              int quantity,
              double price,
              java.lang.String receipt,
              java.lang.String receiptSignature)

setUserProperties

public void setUserProperties(org.json.JSONObject userProperties)

setUserProperties

public void setUserProperties(org.json.JSONObject userProperties,
                     boolean replace)

getUserId

public java.lang.String getUserId()

Returns:

The developer specified identifier for tracking within the analytics system. Can be null.

setUserId

public void setUserId(java.lang.String userId)

uploadEvents

public void uploadEvents()

updateServer

protected void updateServer()

updateServer

protected void updateServer(boolean limit)

makeEventUploadPostRequest

protected void makeEventUploadPostRequest(com.squareup.okhttp.OkHttpClient client,
                              java.lang.String events,
                              long maxId)

getDeviceId

public java.lang.String getDeviceId()

Returns:

A unique identifier for tracking within the analytics system. Can be null if deviceId hasn't been initialized yet;

replaceWithJSONNull

protected java.lang.Object replaceWithJSONNull(java.lang.Object obj)

contextAndApiKeySet

protected boolean contextAndApiKeySet(java.lang.String methodName)

getSharedPreferencesName

protected java.lang.String getSharedPreferencesName()

bytesToHexString

protected java.lang.String bytesToHexString(byte[] bytes)