RakamClient (Rakam Android SDK 2.7.14 API)

java.lang.Object
- io.rakam.api.RakamClient

```
public class RakamClient
extends Object
```
RakamClient
This is the SDK instance class that contains all of the SDK functionality.

Note: call the methods on the default shared instance in the Rakam class, for example: Rakam.getInstance().logEvent();

Many of the SDK functions return the SDK instance back, allowing you to chain multiple method calls together, for example: Rakam.getInstance().initialize(this, "APIKEY").enableForegroundTracking(getApplication())

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`apiKey` The Rakam App API key.
`protected android.content.Context`	`context` The Android App Context.
`protected io.rakam.api.DatabaseHelper`	`dbHelper` The shared Rakam database helper instance.
`static String`	`DEVICE_ID_KEY` The pref/database key for the device ID value.
`protected String`	`deviceId` The user's Device ID value.
`static String`	`END_SESSION_EVENT` The event type for end session events.
`protected okhttp3.OkHttpClient`	`httpClient` The shared OkHTTPClient instance.
`protected boolean`	`initialized`
`protected String`	`instanceName` The name for this instance of RakamClient.
`static okhttp3.MediaType`	`JSON`
`static String`	`LAST_EVENT_ID_KEY` The pref/database key for the last event ID value.
`static String`	`LAST_EVENT_TIME_KEY` The pref/database key for the last event time.
`static String`	`LAST_IDENTIFY_ID_KEY` The pref/database key for the last identify ID value.
`static String`	`OPT_OUT_KEY` The pref/database key for the opt out flag.
`protected String`	`platform` The device's Platform value.
`static String`	`PREVIOUS_SESSION_ID_KEY` The pref/database key for the previous session ID value.
`static String`	`START_SESSION_EVENT` The event type for start session events.
`static String`	`SUPER_PROPERTIES_KEY` The pref/database key for the super properties.
`static String`	`TAG` The class identifier tag used in logging.
`static String`	`USER_ID_KEY` The pref/database key for the user ID value.
`protected String`	`userId` The user's ID value.

Constructor Summary

Constructors
Constructor and Description
`RakamClient()` Instantiates a new default instance RakamClient and starts worker threads.
`RakamClient(String instance)` Instantiates a new RakamClient and starts worker threads.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected String`	`bytesToHexString(byte[] bytes)` Internal method to convert bytes to hex string
`void`	`clearSuperProperties()` Clear super properties.
`void`	`clearUserProperties()` Clear user properties.
`protected boolean`	`contextAndApiKeySet(String methodName)` Internal method to check whether application context and api key are set
`RakamClient`	`disableDiagnosticLogging()`
`RakamClient`	`disableLocationListening()` Disable location listening in the SDK.
`RakamClient`	`enableDiagnosticLogging()`
`RakamClient`	`enableForegroundTracking(android.app.Application app)` Enable foreground tracking for the SDK.
`RakamClient`	`enableLocationListening()` Enable location listening in the SDK.
`RakamClient`	`enableLogging(boolean enableLogging)` Enable/disable message logging by the SDK.
`RakamClient`	`enableNewDeviceIdPerInstall(boolean newDeviceIdPerInstall)` Deprecated.
`String`	`getApiUrl()`
`protected long`	`getCurrentTimeMillis()` Internal method to fetch the current time millis.
`String`	`getDeviceId()` Get the current device id.
`long`	`getSessionId()` Gets the current session id.
`org.json.JSONObject`	`getSuperProperties()` Get super property keys for the user.
`Object`	`getUserId()` Gets the user's id.
`void`	`identify(Identify identify)` Identify.
`void`	`identify(Identify identify, boolean outOfSession)` Identify.
`RakamClient`	`initialize(android.content.Context context, URL apiUrl, String apiKey)` Initialize the Rakam SDK with the Android application context and your Rakam App API key.
`RakamClient`	`initialize(android.content.Context context, URL apiUrl, String apiKey, String userId)` Initialize the Rakam SDK with the Android application context and your Rakam App API key.
`RakamClient`	`initialize(android.content.Context context, URL apiUrl, String apiKey, String userId, String platform, boolean enableDiagnosticLogging)` Initialize the Rakam SDK with the Android application context, your Rakam App API key, and a user ID for the current user.
`boolean`	`isOptedOut()` Returns whether or not the user is opted out of tracking.
`void`	`logEvent(String eventType)` Log an event with the specified event type.
`void`	`logEvent(String eventType, org.json.JSONObject eventProperties)` Log an event with the specified event type and event properties.
`void`	`logEvent(String eventType, org.json.JSONObject eventProperties, boolean outOfSession)` Log an event with the specified event type and event properties.
`protected long`	`logEvent(String eventType, org.json.JSONObject eventProperties, long timestamp, boolean outOfSession)` Log event.
`protected void`	`logEventAsync(String eventType, org.json.JSONObject properties, long timestamp, boolean outOfSession)` Log event async.
`void`	`logEventSync(String eventType)` Log an event with the specified event type.
`void`	`logEventSync(String eventType, org.json.JSONObject eventProperties)` Log an event with the specified event type and event properties.
`void`	`logEventSync(String eventType, org.json.JSONObject eventProperties, boolean outOfSession)` Log an event with the specified event type, event properties, with optional out of session flag.
`void`	`logRevenue(Revenue revenue)` Log revenue.
`protected void`	`makeEventUploadPostRequest(okhttp3.OkHttpClient client, String body, long maxEventId, long maxIdentifyId)` Internal method to generate the event upload post request.
`protected android.util.Pair<android.util.Pair<Long,Long>,org.json.JSONArray>`	`mergeEventsAndIdentifys(List<org.json.JSONObject> events, List<org.json.JSONObject> identifys, long numEvents)` Internal method to merge unsent events and identifies into a single array by sequence number.
`RakamClient`	`regenerateDeviceId()` Regenerates a new random deviceId for current user.
`protected Object`	`replaceWithJSONNull(Object obj)` Internal method to replace null event fields with JSON null object.
`protected long`	`saveEvent(String eventType, org.json.JSONObject event)` Save event long.
`void`	`setApiUrl(URL apiUrl)`
`RakamClient`	`setDeviceId(String deviceId)` Sets a custom device id.
`RakamClient`	`setDiagnosticEventMaxCount(int eventMaxCount)`
`RakamClient`	`setEventMaxCount(int eventMaxCount)` Sets event max count.
`RakamClient`	`setEventUploadMaxBatchSize(int eventUploadMaxBatchSize)` Sets event upload max batch size.
`RakamClient`	`setEventUploadPeriodMillis(int eventUploadPeriodMillis)` Sets event upload period millis.
`RakamClient`	`setEventUploadThreshold(int eventUploadThreshold)` Sets event upload threshold.
`RakamClient`	`setFlushEventsOnClose(boolean flushEventsOnClose)` Enable/disable flushing of unsent events on app close (enabled by default).
`RakamClient`	`setLogLevel(int logLevel)` Sets the logging level.
`RakamClient`	`setMinTimeBetweenSessionsMillis(long minTimeBetweenSessionsMillis)` Sets min time between sessions millis.
`RakamClient`	`setOffline(boolean offline)` Sets offline.
`RakamClient`	`setOptOut(boolean optOut)` Sets opt out.
`RakamClient`	`setSessionTimeoutMillis(long sessionTimeoutMillis)` Sets session timeout millis.
`RakamClient`	`setSuperProperties(org.json.JSONObject superProperties)` Sets super property keys for the user.
`RakamClient`	`setTrackingOptions(TrackingOptions trackingOptions)`
`RakamClient`	`setUserId(int userId)` Sets the user id (can be null).
`RakamClient`	`setUserId(String userId)` Sets the user id (can be null).
`RakamClient`	`setUserId(String userId, boolean startNewSession)` Sets the user id (can be null).
`void`	`setUserProperties(org.json.JSONObject userProperties)` Sets user properties.
`void`	`setUserProperties(org.json.JSONObject userProperties, boolean replace)` Deprecated.
`boolean`	`startNewSessionIfNeeded(long timestamp)` Public method to start a new session if needed.
`RakamClient`	`trackSessionEvents(boolean trackingSessionEvents)` Track session events rakam client.
`org.json.JSONArray`	`truncate(org.json.JSONArray array)` Truncate values in a JSON array.
`org.json.JSONObject`	`truncate(org.json.JSONObject object)` Truncate values in a JSON object.
`protected void`	`updateServer()` Internal method to upload unsent events.
`protected void`	`updateServer(boolean limit)` Internal method to upload unsent events.
`void`	`uploadEvents()` Force SDK to upload any unsent events.
`RakamClient`	`useAdvertisingIdForDeviceId()` Whether to use the Android advertising ID (ADID) as the user's device ID.
`protected boolean`	`validateLogEvent(String eventType)` Validate the event type being logged.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JSON
```
public static final okhttp3.MediaType JSON
```
  - TAG
```
public static final String TAG
```
    The class identifier tag used in logging. TAG = "RakamClient";
    
    See Also:
    
    Constant Field Values
  - START_SESSION_EVENT
```
public static final String START_SESSION_EVENT
```
    The event type for start session events.
    
    See Also:
    
    Constant Field Values
  - END_SESSION_EVENT
```
public static final String END_SESSION_EVENT
```
    The event type for end session events.
    
    See Also:
    
    Constant Field Values
  - DEVICE_ID_KEY
```
public static final String DEVICE_ID_KEY
```
    The pref/database key for the device ID value.
    
    See Also:
    
    Constant Field Values
  - USER_ID_KEY
```
public static final String USER_ID_KEY
```
    The pref/database key for the user ID value.
    
    See Also:
    
    Constant Field Values
  - SUPER_PROPERTIES_KEY
```
public static final String SUPER_PROPERTIES_KEY
```
    The pref/database key for the super properties.
    
    See Also:
    
    Constant Field Values
  - OPT_OUT_KEY
```
public static final String OPT_OUT_KEY
```
    The pref/database key for the opt out flag.
    
    See Also:
    
    Constant Field Values
  - LAST_EVENT_TIME_KEY
```
public static final String LAST_EVENT_TIME_KEY
```
    The pref/database key for the last event time.
    
    See Also:
    
    Constant Field Values
  - LAST_EVENT_ID_KEY
```
public static final String LAST_EVENT_ID_KEY
```
    The pref/database key for the last event ID value.
    
    See Also:
    
    Constant Field Values
  - LAST_IDENTIFY_ID_KEY
```
public static final String LAST_IDENTIFY_ID_KEY
```
    The pref/database key for the last identify ID value.
    
    See Also:
    
    Constant Field Values
  - PREVIOUS_SESSION_ID_KEY
```
public static final String PREVIOUS_SESSION_ID_KEY
```
    The pref/database key for the previous session ID value.
    
    See Also:
    
    Constant Field Values
  - context
```
protected android.content.Context context
```
    The Android App Context.
  - httpClient
```
protected okhttp3.OkHttpClient httpClient
```
    The shared OkHTTPClient instance.
  - dbHelper
```
protected io.rakam.api.DatabaseHelper dbHelper
```
    The shared Rakam database helper instance.
  - apiKey
```
protected String apiKey
```
    The Rakam App API key.
  - instanceName
```
protected String instanceName
```
    The name for this instance of RakamClient.
  - userId
```
protected String userId
```
    The user's ID value.
  - deviceId
```
protected String deviceId
```
    The user's Device ID value.
  - initialized
```
protected boolean initialized
```
  - platform
```
protected String platform
```
    The device's Platform value.
- Constructor Detail
  - RakamClient
```
public RakamClient()
```
    Instantiates a new default instance RakamClient and starts worker threads.
  - RakamClient
```
public RakamClient(String instance)
```
    Instantiates a new RakamClient and starts worker threads.
- Method Detail
  - initialize
```
public RakamClient initialize(android.content.Context context,
                              URL apiUrl,
                              String apiKey)
```
    Initialize the Rakam SDK with the Android application context and your Rakam App API key. Note: initialization is required before you log events and modify user properties.
    
    Parameters:
    
    context - the Android application context
    
    apiUrl - your Rakam API Url
    
    apiKey - your Rakam App API key
    
    Returns:
    
    the RakamClient
  - initialize
```
public RakamClient initialize(android.content.Context context,
                              URL apiUrl,
                              String apiKey,
                              String userId)
```
    Initialize the Rakam SDK with the Android application context and your Rakam App API key. Note: initialization is required before you log events and modify user properties.
    
    Parameters:
    
    context - the Android application context
    
    apiUrl - your Rakam API Url
    
    apiKey - your Rakam App API key
    
    userId - your Application User Id
    
    Returns:
    
    the RakamClient
  - initialize
```
public RakamClient initialize(android.content.Context context,
                              URL apiUrl,
                              String apiKey,
                              String userId,
                              String platform,
                              boolean enableDiagnosticLogging)
```
    Initialize the Rakam SDK with the Android application context, your Rakam App API key, and a user ID for the current user. Note: initialization is required before you log events and modify user properties.
    
    Parameters:
    
    context - the Android application context
    
    apiUrl - your Rakam App API Url
    
    apiKey - your Rakam App API key
    
    userId - your Application User Id
    
    platform - The platform name
    
    enableDiagnosticLogging - Enable error tracking to Rakam APIs
    
    Returns:
    
    the RakamClient
  - setSuperProperties
```
public RakamClient setSuperProperties(org.json.JSONObject superProperties)
```
    Sets super property keys for the user. Super properties allow you to continuously attach a property to every event you track automatically.
    
    Parameters:
    
    superProperties - Super properties
    
    Returns:
    
    the RakamClient
  - getSuperProperties
```
public org.json.JSONObject getSuperProperties()
```
    Get super property keys for the user.
    
    Returns:
    
    the super properties
  - enableForegroundTracking
```
public RakamClient enableForegroundTracking(android.app.Application app)
```
    Enable foreground tracking for the SDK. This is HIGHLY RECOMMENDED, and will allow for accurate session tracking.
    
    Parameters:
    
    app - the Android application
    
    Returns:
    
    the RakamClient
    
    See Also:
    
    Tracking Sessions
  - enableDiagnosticLogging
```
public RakamClient enableDiagnosticLogging()
```
  - disableDiagnosticLogging
```
public RakamClient disableDiagnosticLogging()
```
  - setDiagnosticEventMaxCount
```
public RakamClient setDiagnosticEventMaxCount(int eventMaxCount)
```
  - enableNewDeviceIdPerInstall
```
public RakamClient enableNewDeviceIdPerInstall(boolean newDeviceIdPerInstall)
```
    Deprecated.
    
    Whether to set a new device ID per install. If true, then the SDK will always generate a new device ID on app install (as opposed to re-using an existing value like ADID).
    
    Parameters:
    
    newDeviceIdPerInstall - whether to set a new device ID on app install.
    
    Returns:
    
    the RakamClient
  - useAdvertisingIdForDeviceId
```
public RakamClient useAdvertisingIdForDeviceId()
```
    Whether to use the Android advertising ID (ADID) as the user's device ID.
    
    Returns:
    
    the RakamClient
  - enableLocationListening
```
public RakamClient enableLocationListening()
```
    Enable location listening in the SDK. This will add the user's current lat/lon coordinates to every event logged.
    
    Returns:
    
    the RakamClient
  - disableLocationListening
```
public RakamClient disableLocationListening()
```
    Disable location listening in the SDK. This will stop the sending of the user's current lat/lon coordinates.
    
    Returns:
    
    the RakamClient
  - setEventUploadThreshold
```
public RakamClient setEventUploadThreshold(int eventUploadThreshold)
```
    Sets event upload threshold. The SDK will attempt to batch upload unsent events every eventUploadPeriodMillis milliseconds, or if the unsent event count exceeds the event upload threshold.
    
    Parameters:
    
    eventUploadThreshold - the event upload threshold
    
    Returns:
    
    the RakamClient
  - setEventUploadMaxBatchSize
```
public RakamClient setEventUploadMaxBatchSize(int eventUploadMaxBatchSize)
```
    Sets event upload max batch size. This controls the maximum number of events sent with each upload request.
    
    Parameters:
    
    eventUploadMaxBatchSize - the event upload max batch size
    
    Returns:
    
    the RakamClient
  - setEventMaxCount
```
public RakamClient setEventMaxCount(int eventMaxCount)
```
    Sets event max count. This is the maximum number of unsent events to keep on the device (for example if the device does not have internet connectivity and cannot upload events). If the number of unsent events exceeds the max count, then the SDK begins dropping events, starting from the earliest logged.
    
    Parameters:
    
    eventMaxCount - the event max count
    
    Returns:
    
    the RakamClient
  - setEventUploadPeriodMillis
```
public RakamClient setEventUploadPeriodMillis(int eventUploadPeriodMillis)
```
    Sets event upload period millis. The SDK will attempt to batch upload unsent events every eventUploadPeriodMillis milliseconds, or if the unsent event count exceeds the event upload threshold.
    
    Parameters:
    
    eventUploadPeriodMillis - the event upload period millis
    
    Returns:
    
    the RakamClient
  - setMinTimeBetweenSessionsMillis
```
public RakamClient setMinTimeBetweenSessionsMillis(long minTimeBetweenSessionsMillis)
```
    Sets min time between sessions millis.
    
    Parameters:
    
    minTimeBetweenSessionsMillis - the min time between sessions millis
    
    Returns:
    
    the min time between sessions millis
  - setSessionTimeoutMillis
```
public RakamClient setSessionTimeoutMillis(long sessionTimeoutMillis)
```
    Sets session timeout millis. If foreground tracking has not been enabled with
    
    Parameters:
    
    sessionTimeoutMillis - the session timeout millis
    
    Returns:
    
    the RakamClient
  - setTrackingOptions
```
public RakamClient setTrackingOptions(TrackingOptions trackingOptions)
```
  - setOptOut
```
public RakamClient setOptOut(boolean optOut)
```
    Sets opt out. If true then the SDK does not track any events for the user.
    
    Parameters:
    
    optOut - whether or not to opt the user out of tracking
    
    Returns:
    
    the RakamClient
  - isOptedOut
```
public boolean isOptedOut()
```
    Returns whether or not the user is opted out of tracking.
    
    Returns:
    
    the optOut flag value
  - enableLogging
```
public RakamClient enableLogging(boolean enableLogging)
```
    Enable/disable message logging by the SDK.
    
    Parameters:
    
    enableLogging - whether to enable message logging by the SDK.
    
    Returns:
    
    the RakamClient
  - setLogLevel
```
public RakamClient setLogLevel(int logLevel)
```
    Sets the logging level. Logging messages will only appear if they are the same severity level or higher than the set log level.
    
    Parameters:
    
    logLevel - the log level
    
    Returns:
    
    the RakamClient
  - setOffline
```
public RakamClient setOffline(boolean offline)
```
    Sets offline. If offline is true, then the SDK will not upload events to Rakam servers; however, it will still log events.
    
    Parameters:
    
    offline - whether or not the SDK should be offline
    
    Returns:
    
    the RakamClient
  - setFlushEventsOnClose
```
public RakamClient setFlushEventsOnClose(boolean flushEventsOnClose)
```
    Enable/disable flushing of unsent events on app close (enabled by default).
    
    Parameters:
    
    flushEventsOnClose - whether to flush unsent events on app close
    
    Returns:
    
    the RakamClient
  - trackSessionEvents
```
public RakamClient trackSessionEvents(boolean trackingSessionEvents)
```
    Track session events rakam client. If enabled then the SDK will automatically send start and end session events to mark the start and end of the user's sessions.
    
    Parameters:
    
    trackingSessionEvents - whether to enable tracking of session events
    
    Returns:
    
    the RakamClient
    
    See Also:
    
    Tracking Sessions
  - logEvent
```
public void logEvent(String eventType)
```
    Log an event with the specified event type. Note: this is asynchronous and happens on a background thread.
    
    Parameters:
    
    eventType - the event type
  - logEvent
```
public void logEvent(String eventType,
                     org.json.JSONObject eventProperties)
```
    Log an event with the specified event type and event properties. Note: this is asynchronous and happens on a background thread.
    
    Parameters:
    
    eventType - the event type
    
    eventProperties - the event properties
    
    See Also:
    
    Setting Event Properties
  - logEvent
```
public void logEvent(String eventType,
                     org.json.JSONObject eventProperties,
                     boolean outOfSession)
```
    Log an event with the specified event type and event properties. Note: this is asynchronous and happens on a background thread.
    
    Parameters:
    
    eventType - the event type
    
    eventProperties - the event properties
    
    outOfSession - the out of session
    
    See Also:
    
    Setting Event Properties
  - logEventSync
```
public void logEventSync(String eventType)
```
    Log an event with the specified event type. Note: this is version is synchronous and blocks the main thread until done.
    
    Parameters:
    
    eventType - the event type
  - logEventSync
```
public void logEventSync(String eventType,
                         org.json.JSONObject eventProperties)
```
    Log an event with the specified event type and event properties. Note: this is version is synchronous and blocks the main thread until done.
    
    Parameters:
    
    eventType - the event type
    
    eventProperties - the event properties
    
    See Also:
    
    Setting Event Properties
  - logEventSync
```
public void logEventSync(String eventType,
                         org.json.JSONObject eventProperties,
                         boolean outOfSession)
```
    Log an event with the specified event type, event properties, with optional out of session flag. If out of session is true, then the sessionId will be -1 for the event, indicating that it is not part of the current session. Note: this might be useful when logging events for notifications received. Note: this is version is synchronous and blocks the main thread until done.
    
    Parameters:
    
    eventType - the event type
    
    eventProperties - the event properties
    
    outOfSession - the out of session
    
    See Also:
    
    Setting Event Properties, Tracking Sessions
  - validateLogEvent
```
protected boolean validateLogEvent(String eventType)
```
    Validate the event type being logged. Also verifies that the context and API key have been set already with an initialize call.
    
    Parameters:
    
    eventType - the event type
    
    Returns:
    
    true if the event type is valid
  - logEventAsync
```
protected void logEventAsync(String eventType,
                             org.json.JSONObject properties,
                             long timestamp,
                             boolean outOfSession)
```
    Log event async. Internal method to handle the synchronous logging of events.
    
    Parameters:
    
    eventType - the event type
    
    properties - the request properties
    
    timestamp - the timestamp
    
    outOfSession - the out of session
  - logEvent
```
protected long logEvent(String eventType,
                        org.json.JSONObject eventProperties,
                        long timestamp,
                        boolean outOfSession)
```
    Log event. Internal method to handle the asynchronous logging of events on background thread.
    
    Parameters:
    
    eventType - the event type
    
    eventProperties - the event properties
    
    timestamp - the timestamp
    
    outOfSession - the out of session
    
    Returns:
    
    the event ID if succeeded, else -1.
  - saveEvent
```
protected long saveEvent(String eventType,
                         org.json.JSONObject event)
```
    Save event long. Internal method to save an event to the database.
    
    Parameters:
    
    eventType - the event type
    
    event - the event
    
    Returns:
    
    the event ID if succeeded, else -1
  - getSessionId
```
public long getSessionId()
```
    Gets the current session id.
    
    Returns:
    
    The current sessionId value.
  - startNewSessionIfNeeded
```
public boolean startNewSessionIfNeeded(long timestamp)
```
    Public method to start a new session if needed.
    
    Parameters:
    
    timestamp - the timestamp
    
    Returns:
    
    whether or not a new session was started
  - logRevenue
```
public void logRevenue(Revenue revenue)
```
    Log revenue. Create a Revenue object to hold your revenue data and properties, and log it as a revenue event using logRevenue.
    
    Parameters:
    
    revenue - a Revenue object
    
    See Also:
    
    Revenue, Tracking Revenue
  - setUserProperties
```
public void setUserProperties(org.json.JSONObject userProperties,
                              boolean replace)
```
    Deprecated.
    
    Sets user properties. This is a convenience wrapper around the Identify API to set multiple user properties with a single command. Note: the replace parameter is deprecated and has no effect.
    
    Parameters:
    
    userProperties - the user properties
    
    replace - the replace - has no effect
    
    See Also:
    
    User Properties
  - setUserProperties
```
public void setUserProperties(org.json.JSONObject userProperties)
```
    Sets user properties. This is a convenience wrapper around the Identify API to set multiple user properties with a single command.
    
    Parameters:
    
    userProperties - the user properties
    
    See Also:
    
    User Properties
  - clearUserProperties
```
public void clearUserProperties()
```
    Clear user properties. This will clear all user properties at once. Note: the result is irreversible!
    
    See Also:
    
    User Properties
  - clearSuperProperties
```
public void clearSuperProperties()
```
    Clear super properties. This will clear all super properties at once. Note: the result is irreversible!
    
    See Also:
    
    Super Properties
  - identify
```
public void identify(Identify identify)
```
    Identify. Use this to send an Identify object containing user property operations to Rakam server.
    
    Parameters:
    
    identify - an Identify object
    
    See Also:
    
    Identify, User Properties
  - identify
```
public void identify(Identify identify,
                     boolean outOfSession)
```
    Identify. Use this to send an Identify object containing user property operations to Rakam server. If outOfSession is true, then the identify event is sent with a session id of -1, and does not trigger any session-handling logic.
    
    Parameters:
    
    identify - an Identify object
    
    outOfSession - whther to log the identify event out of session
    
    See Also:
    
    Identify, User Properties
  - truncate
```
public org.json.JSONObject truncate(org.json.JSONObject object)
```
    Truncate values in a JSON object. Any string values longer than 1024 characters will be truncated to 1024 characters.
    
    Parameters:
    
    object - the object
    
    Returns:
    
    the truncated JSON object
  - truncate
```
public org.json.JSONArray truncate(org.json.JSONArray array)
                            throws org.json.JSONException
```
    Truncate values in a JSON array. Any string values longer than 1024 characters will be truncated to 1024 characters.
    
    Parameters:
    
    array - the array
    
    Returns:
    
    the truncated JSON array
    
    Throws:
    
    org.json.JSONException - the json exception
  - getUserId
```
public Object getUserId()
```
    Gets the user's id. Can be null.
    
    Returns:
    
    The developer specified identifier for tracking within the analytics system.
  - setUserId
```
public RakamClient setUserId(String userId)
```
    Sets the user id (can be null).
    
    Parameters:
    
    userId - the user id
    
    Returns:
    
    the RakamClient
  - setUserId
```
public RakamClient setUserId(String userId,
                             boolean startNewSession)
```
    Sets the user id (can be null). If startNewSession is true, ends the session for the previous user and starts a new session for the new user id.
    
    Parameters:
    
    userId - the user id
    
    Returns:
    
    the RakamClient
  - setUserId
```
public RakamClient setUserId(int userId)
```
    Sets the user id (can be null).
    
    Parameters:
    
    userId - the user id
    
    Returns:
    
    the RakamClient
  - setDeviceId
```
public RakamClient setDeviceId(String deviceId)
```
    Sets a custom device id. Note: only do this if you know what you are doing!
    
    Parameters:
    
    deviceId - the device id
    
    Returns:
    
    the RakamClient
    
    See Also:
    
    Custom Device Ids
  - regenerateDeviceId
```
public RakamClient regenerateDeviceId()
```
    Regenerates a new random deviceId for current user. Note: this is not recommended unless you know what you are doing. This can be used in conjunction with setUserId(null) to anonymize users after they log out. With a null userId and a completely new deviceId, the current user would appear as a brand new user in dashboard.
    
    See Also:
    
    Logging Out Users
  - uploadEvents
```
public void uploadEvents()
```
    Force SDK to upload any unsent events.
  - updateServer
```
protected void updateServer()
```
    Internal method to upload unsent events.
  - updateServer
```
protected void updateServer(boolean limit)
```
    Internal method to upload unsent events. Limit controls whether to use event upload max batch size or backoff upload batch size. Note: always call this on logThread
    
    Parameters:
    
    limit - the limit
  - mergeEventsAndIdentifys
```
protected android.util.Pair<android.util.Pair<Long,Long>,org.json.JSONArray> mergeEventsAndIdentifys(List<org.json.JSONObject> events,
                                                                                                     List<org.json.JSONObject> identifys,
                                                                                                     long numEvents)
                                                                                              throws org.json.JSONException
```
    Internal method to merge unsent events and identifies into a single array by sequence number.
    
    Parameters:
    
    events - the events
    
    identifys - the identifys
    
    numEvents - the num events
    
    Returns:
    
    the merged array, max event id, and max identify id
    
    Throws:
    
    org.json.JSONException - the json exception
  - makeEventUploadPostRequest
```
protected void makeEventUploadPostRequest(okhttp3.OkHttpClient client,
                                          String body,
                                          long maxEventId,
                                          long maxIdentifyId)
```
    Internal method to generate the event upload post request.
    
    Parameters:
    
    client - the client
    
    body - request body
    
    maxEventId - the max event id
    
    maxIdentifyId - the max identify id
  - getDeviceId
```
public String getDeviceId()
```
    Get the current device id. Can be null if deviceId hasn't been initialized yet.
    
    Returns:
    
    A unique identifier for tracking within the analytics system.
  - getApiUrl
```
public String getApiUrl()
```
  - setApiUrl
```
public void setApiUrl(URL apiUrl)
```
  - replaceWithJSONNull
```
protected Object replaceWithJSONNull(Object obj)
```
    Internal method to replace null event fields with JSON null object.
    
    Parameters:
    
    obj - the obj
    
    Returns:
    
    the object
  - contextAndApiKeySet
```
protected boolean contextAndApiKeySet(String methodName)
```
    Internal method to check whether application context and api key are set
    
    Parameters:
    
    methodName - the parent method name to print in error message
    
    Returns:
    
    whether application context and api key are set
  - bytesToHexString
```
protected String bytesToHexString(byte[] bytes)
```
    Internal method to convert bytes to hex string
    
    Parameters:
    
    bytes - the bytes
    
    Returns:
    
    the string
  - getCurrentTimeMillis
```
protected long getCurrentTimeMillis()
```
    Internal method to fetch the current time millis. Used for testing.
    
    Returns:
    
    the current time millis

Class RakamClient

RakamClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON

TAG

START_SESSION_EVENT

END_SESSION_EVENT

DEVICE_ID_KEY

USER_ID_KEY

SUPER_PROPERTIES_KEY

OPT_OUT_KEY

LAST_EVENT_TIME_KEY

LAST_EVENT_ID_KEY

LAST_IDENTIFY_ID_KEY

PREVIOUS_SESSION_ID_KEY

context

httpClient

dbHelper

apiKey

instanceName

userId

deviceId

initialized

platform

Constructor Detail

RakamClient

RakamClient

Method Detail

initialize

initialize

initialize

setSuperProperties

getSuperProperties

enableForegroundTracking

enableDiagnosticLogging

disableDiagnosticLogging

setDiagnosticEventMaxCount

enableNewDeviceIdPerInstall

useAdvertisingIdForDeviceId

enableLocationListening

disableLocationListening

setEventUploadThreshold

setEventUploadMaxBatchSize

setEventMaxCount

setEventUploadPeriodMillis

setMinTimeBetweenSessionsMillis

setSessionTimeoutMillis

setTrackingOptions

setOptOut

isOptedOut

enableLogging

setLogLevel

setOffline

setFlushEventsOnClose

trackSessionEvents

logEvent

logEvent

logEvent

logEventSync

logEventSync

logEventSync

validateLogEvent

logEventAsync

logEvent

saveEvent

getSessionId

startNewSessionIfNeeded

logRevenue

setUserProperties

setUserProperties

clearUserProperties

clearSuperProperties

identify

identify

truncate

truncate