io.rakam.api

Class Rakam

java.lang.Object

io.rakam.api.Rakam

public class Rakam
extends Object

Rakam

This is the main Rakam class that manages SDK instances.

NOTE: All of the methods except getInstance() have been deprecated. Please call those methods on the RakamClient instance instead, for example: Rakam.getInstance().logEvent();

See Also:

RakamClient

Constructor Summary

Constructors

Constructor and Description
Rakam()

Method Summary

Modifier and Type	Method and Description
static void	disableLocationListening() Deprecated.
static void	enableLocationListening() Deprecated.
static void	enableNewDeviceIdPerInstall(boolean newDeviceIdPerInstall) Deprecated.
static void	endSession() Deprecated.
static String	getDeviceId() Deprecated.
static RakamClient	getInstance() Gets the default instance.
static RakamClient	getInstance(String instance) Gets the specified instance.
static void	initialize(android.content.Context context, URL apiUrl, String apiKey) Deprecated.
static void	initialize(android.content.Context context, URL apiUrl, String apiKey, String userId) Deprecated.
static void	logEvent(String eventType) Deprecated.
static void	logEvent(String eventType, org.json.JSONObject eventProperties) Deprecated.
static void	logRevenue(String productId, int quantity, double price) Deprecated.
static void	logRevenue(String productId, int quantity, double price, String receipt, String receiptSignature) Deprecated.
static void	setOptOut(boolean optOut) Deprecated.
static void	setSessionTimeoutMillis(long sessionTimeoutMillis) Deprecated.
static void	setUserId(String userId) Deprecated.
static void	setUserProperties(org.json.JSONObject userProperties) Deprecated.
static void	setUserProperties(org.json.JSONObject userProperties, boolean replace) Deprecated.
static void	startSession() Deprecated.
static void	uploadEvents() Deprecated.
static void	useAdvertisingIdForDeviceId() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rakam

public Rakam()

Method Detail

getInstance

public static RakamClient getInstance()

Gets the default instance.

Returns:

the default instance

getInstance

public static RakamClient getInstance(String instance)

Gets the specified instance. If instance is null or empty string, fetches the default instance instead.

Parameters:

instance - name to get "ex app 1"

Returns:

the specified instance

initialize

@Deprecated
public static void initialize(android.content.Context context,
                                          URL apiUrl,
                                          String apiKey)

Deprecated.

Initialize the SDK with the Android app context and Rakam API key. Initializing is required before calling other methods such as logEvent();.

Parameters:

context - the context

apiKey - the api key

initialize

@Deprecated
public static void initialize(android.content.Context context,
                                          URL apiUrl,
                                          String apiKey,
                                          String userId)

Deprecated.

Initialize the SDK with the Android app context, Rakam API key, and a user Id. Initializing is required before calling other methods such as logEvent();.

Parameters:

context - the context

apiKey - the api key

userId - the user id

enableNewDeviceIdPerInstall

@Deprecated
public static void enableNewDeviceIdPerInstall(boolean newDeviceIdPerInstall)

Deprecated.

Enable new device id per install.

Parameters:

newDeviceIdPerInstall - the new device id per install

useAdvertisingIdForDeviceId

@Deprecated
public static void useAdvertisingIdForDeviceId()

Deprecated.

Use advertising id for device id.

enableLocationListening

@Deprecated
public static void enableLocationListening()

Deprecated.

Enable location listening.

disableLocationListening

@Deprecated
public static void disableLocationListening()

Deprecated.

Disable location listening.

setSessionTimeoutMillis

@Deprecated
public static void setSessionTimeoutMillis(long sessionTimeoutMillis)

Deprecated.

Sets session timeout millis.

Parameters:

sessionTimeoutMillis - the session timeout millis

setOptOut

@Deprecated
public static void setOptOut(boolean optOut)

Deprecated.

Sets opt out.

Parameters:

optOut - the opt out

logEvent

@Deprecated
public static void logEvent(String eventType)

Deprecated.

Log event.

Parameters:

eventType - the event type

logEvent

@Deprecated
public static void logEvent(String eventType,
                                        org.json.JSONObject eventProperties)

Deprecated.

Log event.

Parameters:

eventType - the event type

eventProperties - the event properties

uploadEvents

@Deprecated
public static void uploadEvents()

Deprecated.

Upload events.

startSession

@Deprecated
public static void startSession()

Deprecated.

Start session.

endSession

@Deprecated
public static void endSession()

Deprecated.

End session.

logRevenue

@Deprecated
public static void logRevenue(String productId,
                                          int quantity,
                                          double price)

Deprecated.

Log revenue.

Parameters:

productId - the product id

quantity - the quantity

price - the price

logRevenue

@Deprecated
public static void logRevenue(String productId,
                                          int quantity,
                                          double price,
                                          String receipt,
                                          String receiptSignature)

Deprecated.

Log revenue.

Parameters:

productId - the product id

quantity - the quantity

price - the price

receipt - the receipt

receiptSignature - the receipt signature

setUserProperties

@Deprecated
public static void setUserProperties(org.json.JSONObject userProperties)

Deprecated.

Sets user properties.

Parameters:

userProperties - the user properties

setUserProperties

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

Deprecated.

Sets user properties.

Parameters:

userProperties - the user properties

replace - the replace

setUserId

@Deprecated
public static void setUserId(String userId)

Deprecated.

Sets user id.

Parameters:

userId - the user id

getDeviceId

@Deprecated
public static String getDeviceId()

Deprecated.

Gets device id.

Returns:

the device id