- Source:
Methods
(static) increment(key)
Increment value under the key of this user's custom properties by one
Parameters:
Name | Type | Description |
---|---|---|
key |
string | name of the property to attach to user |
- Source:
(static) increment_by(key, value)
Increment value under the key of this user's custom properties by provided value
Parameters:
Name | Type | Description |
---|---|---|
key |
string | name of the property to attach to user |
value |
number | value by which to increment server value |
- Source:
(static) max(key, value)
Save maximal value under the key of this user's custom properties
Parameters:
Name | Type | Description |
---|---|---|
key |
string | name of the property to attach to user |
value |
number | value which to compare to server's value and store maximal value of both provided |
- Source:
(static) min(key, value)
Save minimal value under the key of this user's custom properties
Parameters:
Name | Type | Description |
---|---|---|
key |
string | name of the property to attach to user |
value |
number | value which to compare to server's value and store minimal value of both provided |
- Source:
(static) multiply(key, value)
Multiply value under the key of this user's custom properties by provided value
Parameters:
Name | Type | Description |
---|---|---|
key |
string | name of the property to attach to user |
value |
number | value by which to multiply server value |
- Source:
(static) pull(key, value)
Remove value from array under the key of this user's custom properties
Parameters:
Name | Type | Description |
---|---|---|
key |
string | name of the property |
value |
string | number | value which to remove from array |
- Source:
(static) push(key, value)
Add value to array under the key of this user's custom properties. If property is not an array, it will be converted to array
Parameters:
Name | Type | Description |
---|---|---|
key |
string | name of the property to attach to user |
value |
string | number | value which to add to array |
- Source:
(static) push_unique(key, value)
Add value to array under the key of this user's custom properties, storing only unique values. If property is not an array, it will be converted to array
Parameters:
Name | Type | Description |
---|---|---|
key |
string | name of the property to attach to user |
value |
string | number | value which to add to array |
- Source:
(static) save()
Save changes made to user's custom properties object and send them to server
- Source:
(static) set(key, value)
Sets user's custom property value
Parameters:
Name | Type | Description |
---|---|---|
key |
string | name of the property to attach to user |
value |
string | number | value to store under provided property |
- Source:
(static) set_once(key, value)
Sets user's custom property value only if it was not set before
Parameters:
Name | Type | Description |
---|---|---|
key |
string | name of the property to attach to user |
value |
string | number | value to store under provided property |
- Source: