com.amplitude.api

Class Identify

java.lang.Object

com.amplitude.api.Identify

public class Identify
extends java.lang.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 Amplitude servers by calling Amplitude.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
protected java.util.Set<java.lang.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(java.lang.String property, double value) Increment a user property by some numerical value.
Identify	add(java.lang.String property, float value) Increment a user property by some numerical value.
Identify	add(java.lang.String property, int value) Increment a user property by some numerical value.
Identify	add(java.lang.String property, org.json.JSONObject values) Increment a user property by some numerical value.
Identify	add(java.lang.String property, long value) Increment a user property by some numerical value.
Identify	add(java.lang.String property, java.lang.String value) Increment a user property by some numerical value.
Identify	append(java.lang.String property, boolean value) Append a value or values to a user property.
Identify	append(java.lang.String property, boolean[] values) Append a value or values to a user property.
Identify	append(java.lang.String property, double value) Append a value or values to a user property.
Identify	append(java.lang.String property, double[] values) Append a value or values to a user property.
Identify	append(java.lang.String property, float value) Append a value or values to a user property.
Identify	append(java.lang.String property, float[] values) Append a value or values to a user property.
Identify	append(java.lang.String property, int value) Append a value or values to a user property.
Identify	append(java.lang.String property, int[] values) Append a value or values to a user property.
Identify	append(java.lang.String property, org.json.JSONArray values) Append a value or values to a user property.
Identify	append(java.lang.String property, org.json.JSONObject values) Append a value or values to a user property.
Identify	append(java.lang.String property, long value) Append a value or values to a user property.
Identify	append(java.lang.String property, long[] values) Append a value or values to a user property.
Identify	append(java.lang.String property, java.lang.String value) Append a value or values to a user property.
Identify	append(java.lang.String property, java.lang.String[] values) Append a value or values to a user property.
Identify	clearAll() Clear all user properties.
org.json.JSONObject	getUserPropertiesOperations() Public method that exposes the user property operations JSON blob.
Identify	prepend(java.lang.String property, boolean value) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, boolean[] values) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, double value) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, double[] values) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, float value) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, float[] values) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, int value) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, int[] values) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, org.json.JSONArray values) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, org.json.JSONObject values) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, long value) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, long[] values) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, java.lang.String value) Prepend a value or values to a user property.
Identify	prepend(java.lang.String property, java.lang.String[] values) Prepend a value or values to a user property.
Identify	set(java.lang.String property, boolean value) Sets a user property value.
Identify	set(java.lang.String property, boolean[] values) Sets a user property value.
Identify	set(java.lang.String property, double value) Sets a user property value.
Identify	set(java.lang.String property, double[] values) Sets a user property value.
Identify	set(java.lang.String property, float value) Sets a user property value.
Identify	set(java.lang.String property, float[] values) Sets a user property value.
Identify	set(java.lang.String property, int value) Sets a user property value.
Identify	set(java.lang.String property, int[] values) Sets a user property value.
Identify	set(java.lang.String property, org.json.JSONArray values) Sets a user property value.
Identify	set(java.lang.String property, org.json.JSONObject values) Sets a user property value.
Identify	set(java.lang.String property, long value) Sets a user property value.
Identify	set(java.lang.String property, long[] values) Sets a user property value.
Identify	set(java.lang.String property, java.lang.Object value) Deprecated.
Identify	set(java.lang.String property, java.lang.String value) Sets a user property value.
Identify	set(java.lang.String property, java.lang.String[] values) Sets a user property value.
Identify	setOnce(java.lang.String property, boolean value) Sets a user property value only once.
Identify	setOnce(java.lang.String property, boolean[] values) Sets a user property value only once.
Identify	setOnce(java.lang.String property, double value) Sets a user property value only once.
Identify	setOnce(java.lang.String property, double[] values) Sets a user property value only once.
Identify	setOnce(java.lang.String property, float value) Sets a user property value only once.
Identify	setOnce(java.lang.String property, float[] values) Sets a user property value only once.
Identify	setOnce(java.lang.String property, int value) Sets a user property value only once.
Identify	setOnce(java.lang.String property, int[] values) Sets a user property value only once.
Identify	setOnce(java.lang.String property, org.json.JSONArray values) Sets a user property value only once.
Identify	setOnce(java.lang.String property, org.json.JSONObject values) Sets a user property value only once.
Identify	setOnce(java.lang.String property, long value) Sets a user property value only once.
Identify	setOnce(java.lang.String property, long[] values) Sets a user property value only once.
Identify	setOnce(java.lang.String property, java.lang.Object value) Deprecated.
Identify	setOnce(java.lang.String property, java.lang.String value) Sets a user property value only once.
Identify	setOnce(java.lang.String property, java.lang.String[] values) Sets a user property value only once.
Identify	unset(java.lang.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

userPropertiesOperations

protected org.json.JSONObject userPropertiesOperations

Internal JSONObject to hold all of the user property operations.

userProperties

protected java.util.Set<java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String property,
                        java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String property,
                        java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String property,
                    java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String property,
                    java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String property,
                    java.lang.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(java.lang.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

append

public Identify append(java.lang.String property,
                       boolean value)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

value - the value being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       double value)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

value - the value being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       float value)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

value - the value being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       int value)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

value - the value being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       long value)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

value - the value being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       java.lang.String value)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

value - the value being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       org.json.JSONArray values)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

values - the values being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       org.json.JSONObject values)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

values - the values being appended. Server-side we flatten dictionaries and apply append to each flattened property.

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       boolean[] values)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

values - the values being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       double[] values)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

values - the values being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       float[] values)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

values - the values being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       int[] values)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

values - the values being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       long[] values)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

values - the values being appended

Returns:

the same Identify object

append

public Identify append(java.lang.String property,
                       java.lang.String[] values)

Append a value or values to a user property. If the user property does not have a value set, it will be initialized to an empty list before the new values are appended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) appended.

Parameters:

property - the user property property to which to append

values - the values being appended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        boolean value)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

value - the value being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        double value)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

value - the value being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        float value)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

value - the value being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        int value)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

value - the value being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        long value)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

value - the value being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        java.lang.String value)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

value - the value being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        org.json.JSONArray values)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

values - the value being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        org.json.JSONObject values)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

values - the values being prepended. Server-side we flatten dictionaries and apply prepend to each flattened property.

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        boolean[] values)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

values - the values being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        double[] values)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

values - the values being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        float[] values)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

values - the values being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        int[] values)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

values - the values being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        long[] values)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

values - the values being prepended

Returns:

the same Identify object

prepend

public Identify prepend(java.lang.String property,
                        java.lang.String[] values)

Prepend a value or values to a user property. Prepend means inserting the value(s) at the front of a given list. if the user property does not have a value set, it will be initialized to an empty list before the new values are prepended. If the user property has an existing value and it is not a list, it will be converted into a list with the new value(s) prepended.

Parameters:

property - the user property to which to append

values - the values being prepended

Returns:

the same Identify object

unset

public Identify unset(java.lang.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.

setOnce

public Identify setOnce(java.lang.String property,
                        java.lang.Object value)

Deprecated.

Sets a user property value only once. Subsequent @{code setOnce} operations on that user property will be ignored. Note: this method has been deprecated. Please use one with a different signature.

Parameters:

property - the user property to setOnce

value - the value of the user property

Returns:

the same Identify object

set

public Identify set(java.lang.String property,
                    java.lang.Object value)

Deprecated.

Sets a user property value. Existing values for that user property will be overwritten. Note: this method has been deprecated. Please use one with a different signature.

Parameters:

property - the user property to set

value - the value of the user property

Returns:

the same Identify object

getUserPropertiesOperations

public org.json.JSONObject getUserPropertiesOperations()

Public method that exposes the user property operations JSON blob.

Returns:

a copy of the User Property Operations JSONObject. If copying fails, returns an empty JSONObject