User Properties allow you to label your users based on preferences, behaviors or attributes unique to your app.
For details on the different types and using User Properties see the official documentation.
Client Side API
The user properties state is on the server, and the SDK is a pass thru agent for client state change requests. There are 4 groups of operations (set, add, remove, flag).
- For (set, add), the fist parameter is a key, and the second parameter is a value.
- For (remove), the first parameter is a key, and the second parameter is a value, or omitted to remove all values.
- For (flag), the first parameter is a key and there is no second parameter.
Sets and replaces (if any exist) the value(s) for the property.
Adds a User Property value(s). Adding values already included in the state has no effect and does not error.
Removes a specific User Property value(s) or removes all values. Removing values not already included in the state has no effect and does not error.
or remove all values from the property:
Exactly set, or replace if any previously exists, any value for the property to a single true state Implies that value is boolean and should only be flagged and cleared.