User Attributes are pieces of information you know about a user which could be demographics like age or gender, account-specific like plan, or even things like whether a user has seen a particular A/B test variation. It's up to you! It is basically a customer identity that you can reference across the customer’s whole lifetime.

Implementing Login/Logout

• It's important to set the User Attribute Unique ID when a user logs into your app.
• This is to merge the new user with the existing user, if any exists, and will help prevent creation of unnecessary/stale users.
• Setting the Unique ID is a critical piece to tie a user across devices and installs/uninstalls as well across all platforms (i.e. iOS, Android, Windows, The Web). Set the USER_ATTRIBUTE_UNIQUE_ID attribute as soon as the user is logged in. Unique ID can be something like an email ID, a username (unique), or a database ID or any Backend generated ID.
• Do not set this for the user who not logged in.

Login

//UNIQUE_ID is used to uniquely identify a user.
MoEHelper.getInstance(context).setUniqueId(UNIQUE_ID)

//UNIQUE_ID is used to uniquely identify a user.
MoEHelper.getInstance(context).setUniqueId(UNIQUE_ID);

Note: The following values are not allowed in the UniqueID field: "unknown", "guest", "null", "0", "1", "true", "false", "user_attribute_unique_id", "(empty)", "na", "n/a", "", "dummy_seller_code", "user_id", "id", "customer_id", "uid", "userid", "none", "-2", "-1", "2"

Logout

The application needs to notify the MoEngage SDK whenever the user is logged out of the application. To notify the SDK, call the API whenever the user is logged out of the application.

MoEHelper.getInstance(context).logoutUser()

MoEHelper.getInstance(context).logoutUser();

In case the application is registering for push token it should pass the new push token to MoEngage SDK after user logout. For more information about passing push tokens, refer to Push Configuration for Android SDK.

Updating User Attribute Unique Id

Use the method setAlias() to update the user attribute unique id instead of setUniqueId() with a different value. Using the method setUniqueId() with a new value creates unintended users in MoEngage.

MoEHelper.getInstance(getContext()).setAlias();

Tracking User Attributes

The SDK provides APIs to track commonly tracked user attributes like First Name, Last Name, Email-Id, etc. Please use the provided methods for tracking these attributes.

MoEHelper.getInstance(context).setFirstName()
MoEHelper.getInstance(context).setLastName()
MoEHelper.getInstance(context).setFullName()
MoEHelper.getInstance(context).setUserLocation()
MoEHelper.getInstance(context).setGender()
MoEHelper.getInstance(context).setNumber()
MoEHelper.getInstance(context).setBirthDate()
MoEHelper.getInstance(context).setEmail()

MoEHelper.getInstance(context).setFirstName();
MoEHelper.getInstance(context).setLastName();
MoEHelper.getInstance(context).setFullName();
MoEHelper.getInstance(context).setUserLocation();
MoEHelper.getInstance(context).setGender();
MoEHelper.getInstance(context).setNumber();
MoEHelper.getInstance(context).setBirthDate();
MoEHelper.getInstance(context).setEmail();

 For setting other User Attributes, use the generic method setUserAttribute(key, value). 
Supported types for attribute value are String, int, double, num, bool, List<int>, List<String>, List<double> & List<num>.

// Tracking a String Attribute
MoEHelper.getInstance(context).setUserAttribute("locality", "SF")
// Tracking a Date Attribute
MoEHelper.getInstance(context).setUserAttribute("signedUpOn", Date())
// Tracking a location attribute
MoEHelper.getInstance(context).setUserAttribute("lastLocation", GeoLocation(40.77, 73.98))

// Tracking a String Attribute
MoEHelper.getInstance(context).setUserAttribute("locality", "SF");
// Tracking a Date Attribute
MoEHelper.getInstance(context).setUserAttribute("signedUpOn", new Date());
// Tracking a location attribute
MoEHelper.getInstance(context).setUserAttribute("lastLocation", new GeoLocation(40.77, 73.98));

Reserved keywords for User Attributes

Below is the list of keys that should not be used when tracking user attributes.

• USER_ATTRIBUTE_UNIQUE_ID
• USER_ATTRIBUTE_USER_EMAIL
• USER_ATTRIBUTE_USER_MOBILE
• USER_ATTRIBUTE_USER_NAME
• USER_ATTRIBUTE_USER_GENDER
• USER_ATTRIBUTE_USER_FIRST_NAME
• USER_ATTRIBUTE_USER_LAST_NAME
• USER_ATTRIBUTE_USER_BDAY
• MOE_TIME_FORMAT
• MOE_TIME_TIMEZONE
• USER_ATTRIBUTE_NOTIFICATION_PREF
• USER_ATTRIBUTE_OLD_ID
• MOE_TIME_FORMAT
• MOE_TIME_TIMEZONE
• USER_ATTRIBUTE_DND_START_TIME
• USER_ATTRIBUTE_DND_END_TIME
• MOE_GAID
• MOE_ISLAT
• status