io.rakam.api

Class Identify

java.lang.Object

io.rakam.api.Identify

public class Identify
extends Object

Identify

Identify objects are a wrapper for user property operations. Each method adds a user property operation to the Identify object, and returns the same Identify object, allowing you to chain multiple method calls together, for example: Identify identify = new Identify().set("color", "green").add("karma", 1);

Note: if the same user property is used in multiple operations on a single Identify object, only the first operation on that property will be saved, and the rest will be ignored.

After creating an Identify object and setting the desired operations, send it to Rakam servers by calling Rakam.getInstance().identify(identify); and pass in the object.

See Also:

Android SDK README for more information on the Identify API and user property operations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG The class identifier tag used in logging.
protected Set<String>	userProperties Internal set to keep track of user property keys and test for duplicates.
protected org.json.JSONObject	userPropertiesOperations Internal JSONObject to hold all of the user property operations.

Constructor Summary

Constructors

Constructor and Description
Identify()

Method Summary

Modifier and Type	Method and Description
Identify	add(String property, double value) Increment a user property by some numerical value.
Identify	add(String property, float value) Increment a user property by some numerical value.
Identify	add(String property, int value) Increment a user property by some numerical value.
Identify	add(String property, org.json.JSONObject values) Increment a user property by some numerical value.
Identify	add(String property, long value) Increment a user property by some numerical value.
Identify	add(String property, String value) Increment a user property by some numerical value.
Identify	clearAll() Clear all user properties.
Identify	set(String property, boolean value) Sets a user property value.
Identify	set(String property, boolean[] values) Sets a user property value.
Identify	set(String property, double value) Sets a user property value.
Identify	set(String property, double[] values) Sets a user property value.
Identify	set(String property, float value) Sets a user property value.
Identify	set(String property, float[] values) Sets a user property value.
Identify	set(String property, int value) Sets a user property value.
Identify	set(String property, int[] values) Sets a user property value.
Identify	set(String property, org.json.JSONArray values) Sets a user property value.
Identify	set(String property, org.json.JSONObject values) Sets a user property value.
Identify	set(String property, long value) Sets a user property value.
Identify	set(String property, long[] values) Sets a user property value.
Identify	set(String property, String value) Sets a user property value.
Identify	set(String property, String[] values) Sets a user property value.
Identify	setOnce(String property, boolean value) Sets a user property value only once.
Identify	setOnce(String property, boolean[] values) Sets a user property value only once.
Identify	setOnce(String property, double value) Sets a user property value only once.
Identify	setOnce(String property, double[] values) Sets a user property value only once.
Identify	setOnce(String property, float value) Sets a user property value only once.
Identify	setOnce(String property, float[] values) Sets a user property value only once.
Identify	setOnce(String property, int value) Sets a user property value only once.
Identify	setOnce(String property, int[] values) Sets a user property value only once.
Identify	setOnce(String property, org.json.JSONArray values) Sets a user property value only once.
Identify	setOnce(String property, org.json.JSONObject values) Sets a user property value only once.
Identify	setOnce(String property, long value) Sets a user property value only once.
Identify	setOnce(String property, long[] values) Sets a user property value only once.
Identify	setOnce(String property, String value) Sets a user property value only once.
Identify	setOnce(String property, String[] values) Sets a user property value only once.
Identify	unset(String property) Unset and remove a user property.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final String TAG

The class identifier tag used in logging. TAG = "Identify";

See Also:

Constant Field Values

userPropertiesOperations

protected org.json.JSONObject userPropertiesOperations

Internal JSONObject to hold all of the user property operations.

userProperties

protected Set<String> userProperties

Internal set to keep track of user property keys and test for duplicates.

Constructor Detail

Identify

public Identify()

Method Detail

setOnce

public Identify setOnce(String property,
                        boolean value)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

value - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        double value)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

value - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        float value)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

value - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        int value)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

value - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        long value)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

value - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        String value)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

value - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        org.json.JSONArray values)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

values - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        org.json.JSONObject values)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

values - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        boolean[] values)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

values - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        double[] values)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

values - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        float[] values)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

values - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        int[] values)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

values - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        long[] values)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

values - the value of the user property

Returns:

the same Identify object

setOnce

public Identify setOnce(String property,
                        String[] values)

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored.

Parameters:

property - the user property to setOnce

values - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    boolean value)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

value - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    double value)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

value - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    float value)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

value - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    int value)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

value - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    long value)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

value - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    String value)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

value - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    org.json.JSONObject values)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

values - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    org.json.JSONArray values)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

values - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    boolean[] values)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

values - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    double[] values)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

values - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    float[] values)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

values - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    int[] values)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

values - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    long[] values)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

values - the value of the user property

Returns:

the same Identify object

set

public Identify set(String property,
                    String[] values)

Sets a user property value. Existing values for that user property will be overwritten.

Parameters:

property - the user property to set

values - the value of the user property

Returns:

the same Identify object

add

public Identify add(String property,
                    double value)

Increment a user property by some numerical value. If the user property does not have a value set, it will be initialized to 0 before being incremented. Value can be negative to decrement a user property value.

Parameters:

property - the user property to increment

value - the value (can be negative) to increment

Returns:

the same Identify object

add

public Identify add(String property,
                    float value)

Increment a user property by some numerical value. If the user property does not have a value set, it will be initialized to 0 before being incremented. Value can be negative to decrement a user property value.

Parameters:

property - the user property to increment

value - the value (can be negative) to increment

Returns:

the same Identify object

add

public Identify add(String property,
                    int value)

Increment a user property by some numerical value. If the user property does not have a value set, it will be initialized to 0 before being incremented. Value can be negative to decrement a user property value.

Parameters:

property - the user property to increment

value - the value (can be negative) to increment

Returns:

the same Identify object

add

public Identify add(String property,
                    long value)

Increment a user property by some numerical value. If the user property does not have a value set, it will be initialized to 0 before being incremented. Value can be negative to decrement a user property value.

Parameters:

property - the user property to increment

value - the value (can be negative) to increment

Returns:

the same Identify object

add

public Identify add(String property,
                    String value)

Increment a user property by some numerical value. If the user property does not have a value set, it will be initialized to 0 before being incremented. Value can be negative to decrement a user property value.

Parameters:

property - the user property to increment

value - the value (can be negative) to increment. Server-side we convert the string into a number if possible.

Returns:

the same Identify object

add

public Identify add(String property,
                    org.json.JSONObject values)

Increment a user property by some numerical value. If the user property does not have a value set, it will be initialized to 0 before being incremented. Value can be negative to decrement a user property value.

Parameters:

property - the user property to increment

values - the value (can be negative) to increment. Server-side we flatten dictionaries and apply add to each flattened property value.

Returns:

the same Identify object

unset

public Identify unset(String property)

Unset and remove a user property.

Parameters:

property - the user property to unset and remove.

Returns:

the same Identify object

clearAll

public Identify clearAll()

Clear all user properties. Note: the result is irreversible! Also Note: clearAll needs to be be sent on its own Identify object without any other operations.

Returns:

the same Identify object.