com.braze

Class BrazeUser

java.lang.Object

com.braze.BrazeUser

public class BrazeUser
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BrazeUser(UserCache userCache, IBrazeManager brazeManager, java.lang.String userId, ILocationManager locationManager, ServerConfigStorageProvider serverConfigStorageProvider) Internal constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addAlias(java.lang.String alias, java.lang.String label) Adds an an alias for the current user.
boolean	addToCustomAttributeArray(java.lang.String key, java.lang.String value) Adds a String to a custom attribute string array, or creates that array if one doesn't exist.
boolean	addToSubscriptionGroup(java.lang.String subscriptionGroupId) Adds the user to the subscription group.
java.lang.String	getUserId() Returns the currently tracked user id.
boolean	incrementCustomUserAttribute(java.lang.String key) Increments the value of an custom attribute by one.
boolean	incrementCustomUserAttribute(java.lang.String key, int incrementValue) Increments the value of an custom attribute by a given amount.
boolean	removeFromCustomAttributeArray(java.lang.String key, java.lang.String value) Removes a string element from a custom attribute string array.
boolean	removeFromSubscriptionGroup(java.lang.String subscriptionGroupId) Removes the user from the subscription group.
boolean	setAttributionData(AttributionData attributionData) Sets attribution information for the user.
boolean	setAvatarImageUrl(java.lang.String avatarImageUrl) Sets the Avatar image of the user which will be displayed on the user's profile on the dashboard.
boolean	setCountry(java.lang.String country) Sets the home country of the user.
boolean	setCustomAttributeArray(java.lang.String key, java.lang.String[] values) Sets a String array of custom user attributes.
boolean	setCustomUserAttribute(java.lang.String key, boolean value) Sets a boolean custom user attribute.
boolean	setCustomUserAttribute(java.lang.String key, double value) Sets a double custom user attribute.
boolean	setCustomUserAttribute(java.lang.String key, float value) Sets a float custom user attribute.
boolean	setCustomUserAttribute(java.lang.String key, int value) Sets an int custom user attribute.
boolean	setCustomUserAttribute(java.lang.String key, long value) Sets a long custom user attribute.
boolean	setCustomUserAttribute(java.lang.String key, java.lang.String value) Sets a string custom user attribute.
boolean	setCustomUserAttributeToNow(java.lang.String key) Sets a custom attribute with the given key to the current time.
boolean	setCustomUserAttributeToSecondsFromEpoch(java.lang.String key, long secondsFromEpoch) Sets a custom attribute to the given number of seconds elapsed since the epoch.
boolean	setDateOfBirth(int year, Month month, int day) Sets the date of birth of the user.
boolean	setEmail(java.lang.String email) Sets the email address of the user.
boolean	setEmailNotificationSubscriptionType(NotificationSubscriptionType emailNotificationSubscriptionType) Sets whether or not the user should be sent email campaigns.
boolean	setFacebookData(FacebookUser facebookUserData) Sets the Facebook profile data for this user.
boolean	setFirstName(java.lang.String firstName) Sets the first name of the user.
boolean	setGender(Gender gender) Sets the gender for the user.
boolean	setHomeCity(java.lang.String homeCity) Sets the home city of the user.
boolean	setLanguage(java.lang.String language) Sets the language of the user.
void	setLastKnownLocation(double latitude, double longitude, java.lang.Double altitude, java.lang.Double accuracy) Sets the last known location for the user.
boolean	setLastName(java.lang.String lastName) Sets the last name of the user.
void	setLocationCustomAttribute(java.lang.String key, double latitude, double longitude)
boolean	setPhoneNumber(java.lang.String phoneNumber) Sets the phone number of the user.
boolean	setPushNotificationSubscriptionType(NotificationSubscriptionType pushNotificationSubscriptionType) Sets the push notification subscription status of the user.
boolean	setTwitterData(TwitterUser twitterUserData) Sets the Twitter data for this user.
void	setUserId(java.lang.String userId) Internal method.
boolean	unsetCustomUserAttribute(java.lang.String key) Removes the value associated with the given custom attribute key.
void	unsetLocationCustomAttribute(java.lang.String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrazeUser

public BrazeUser(UserCache userCache,
                 IBrazeManager brazeManager,
                 java.lang.String userId,
                 ILocationManager locationManager,
                 ServerConfigStorageProvider serverConfigStorageProvider)

Internal constructor. Do not call.

Method Detail

addAlias

public boolean addAlias(java.lang.String alias,
                        java.lang.String label)

Adds an an alias for the current user. (alias, label) pairs can exist on one and only one user. If a different user already has this alias or external user id, the alias attempt will be rejected on the server (even if this method returns true).

Parameters:

alias - An alias for the current user.

label - The label of the alias. Used to differentiate it from other aliases for the user.

Returns:

a boolean indicating whether or not the alias was successfully set.

setFirstName

public boolean setFirstName(java.lang.String firstName)

Sets the first name of the user. Used to collect information about the user.

Parameters:

firstName - The first name of the user. A null value will unset the first name for this user.

Returns:

a boolean indicating whether or not the first name was successfully set.

setLastName

public boolean setLastName(java.lang.String lastName)

Sets the last name of the user. Used to collect information about the user.

Parameters:

lastName - The last name of the user. A null value will unset the last name for this user.

Returns:

a boolean indicating whether or not the last name was successfully set.

setEmail

public boolean setEmail(java.lang.String email)

Sets the email address of the user. Used to collect information about the user. Provided email addresses must pass email address validation. The validation method used is available in ValidationUtils.isValidEmailAddress(java.lang.String)

Parameters:

email - The email address of the user. A null value will unset the email address for this user.

Returns:

a boolean indicating whether or not the email was successfully set.

setGender

public boolean setGender(Gender gender)

Sets the gender for the user. Used to collect information about the user.

Parameters:

gender - Gender enum representing the user's gender.

Returns:

a boolean indicating whether or not the gender was successfully set.

setDateOfBirth

public boolean setDateOfBirth(int year,
                              Month month,
                              int day)

Sets the date of birth of the user. Used to collect information about the user.

Parameters:

year - The date of birth year.

month - The date of birth month.

day - The date of birth day of the month.

Returns:

a boolean indicating whether or not the date of birth was successfully set.

setCountry

public boolean setCountry(java.lang.String country)

Sets the home country of the user. Used to collect information about the user.

Parameters:

country - The country of the user. A null value will unset the country for this user.

setHomeCity

public boolean setHomeCity(java.lang.String homeCity)

Sets the home city of the user. Used to collect information about the user.

Parameters:

homeCity - The home city of the user. A null value will unset the home city for this user.

setLanguage

public boolean setLanguage(java.lang.String language)

Sets the language of the user. Language Strings should be valid ISO 639-1 language codes. See https://www.loc.gov/standards/iso639-2/php/code_list.php. If not set here, user language will be inferred from the device locale.

Parameters:

language - The ISO 639-1 language code for the user's language. A null value will unset the language for this user.

setEmailNotificationSubscriptionType

public boolean setEmailNotificationSubscriptionType(NotificationSubscriptionType emailNotificationSubscriptionType)

Sets whether or not the user should be sent email campaigns. Setting it to unsubscribed opts the user out of an email campaign that you create through the Braze dashboard.

Parameters:

emailNotificationSubscriptionType - NotificationSubscriptionType enum representing the user's email notifications subscription type.

setPushNotificationSubscriptionType

public boolean setPushNotificationSubscriptionType(NotificationSubscriptionType pushNotificationSubscriptionType)

Sets the push notification subscription status of the user. Used to collect information about the user.

Parameters:

pushNotificationSubscriptionType - NotificationSubscriptionType enum representing the user's push notifications subscription type.

addToSubscriptionGroup

public boolean addToSubscriptionGroup(java.lang.String subscriptionGroupId)

Adds the user to the subscription group.

Parameters:

subscriptionGroupId - The subscription group ID that the user will be added to

removeFromSubscriptionGroup

public boolean removeFromSubscriptionGroup(java.lang.String subscriptionGroupId)

Removes the user from the subscription group.

Parameters:

subscriptionGroupId - The subscription group ID that the user will be removed from

setPhoneNumber

public boolean setPhoneNumber(java.lang.String phoneNumber)

Sets the phone number of the user. Used to collect information about the user. Provided phone numbers must pass phone number validation. The validation methods used is available in ValidationUtils.isValidPhoneNumber(String)

Parameters:

phoneNumber - The phone number of the user. A null value will unset the phone number for this user.

Returns:

a boolean indicating whether or not the phone number passed basic validation

setCustomUserAttribute

public boolean setCustomUserAttribute(java.lang.String key,
                                      boolean value)

Sets a boolean custom user attribute. This can be any key/value pair and is used to collect extra information about the user. The key parameter is limited to 255 characters in length and can only contain alphanumeric characters and underscores. Keys which are too long will be truncated. See CustomAttributeValidationUtils#isValidCustomAttributeKey.

Parameters:

key - The identifier of the custom attribute

value - The boolean value of the custom attribute

Returns:

whether or not the custom user attribute was set correctly

setCustomUserAttribute

public boolean setCustomUserAttribute(java.lang.String key,
                                      int value)

Sets an int custom user attribute. This can be any key/value pair and is used to collect extra information about the user. The key parameter is limited to 255 characters in length and can only contain alphanumeric characters and underscores. Keys which are too long will be truncated. Keys may not be a reserved key. See CustomAttributeValidationUtils#isValidCustomAttributeKey.

Parameters:

key - The identifier of the custom attribute

value - The int value of the custom attribute

Returns:

whether or not the custom user attribute was set correctly

setCustomUserAttribute

public boolean setCustomUserAttribute(java.lang.String key,
                                      float value)

Sets a float custom user attribute. This can be any key/value pair and is used to collect extra information about the user. The key parameter is limited to 255 characters in length and can only contain alphanumeric characters and underscores. Keys which are too long will be truncated. Keys may not be a reserved key. See CustomAttributeValidationUtils#isValidCustomAttributeKey

Parameters:

key - The identifier of the custom attribute

value - The float value of the custom attribute

Returns:

whether or not the custom user attribute was set correctly

setCustomUserAttribute

public boolean setCustomUserAttribute(java.lang.String key,
                                      long value)

Sets a long custom user attribute. This can be any key/value pair and is used to collect extra information about the user. The key parameter is limited to 255 characters in length and can only contain alphanumeric characters and underscores. Keys which are too long will be truncated. Keys may not be a reserved key. See CustomAttributeValidationUtils#isValidCustomAttributeKey

Parameters:

key - The identifier of the custom attribute

value - The long value of the custom attribute

Returns:

whether or not the custom user attribute was set correctly

setCustomUserAttribute

public boolean setCustomUserAttribute(java.lang.String key,
                                      java.lang.String value)

Sets a string custom user attribute. This can be any key/value pair and is used to collect extra information about the user. The key and value parameters are limited to 255 characters in length. Keys and values which are too long will be truncated. Keys can only contain alphanumeric characters and underscores. Keys may not be a reserved key. See CustomAttributeValidationUtils#isValidCustomAttributeKey

Parameters:

key - The identifier of the custom attribute

value - The String value of the custom attribute

Returns:

whether or not the custom user attribute was set correctly

setCustomUserAttribute

public boolean setCustomUserAttribute(java.lang.String key,
                                      double value)

Sets a double custom user attribute. This can be any key/value pair and is used to collect extra information about the user. The key parameter is limited to 255 characters in length. Keys which are too long will be truncated. Keys can only contain alphanumeric characters and underscores. Keys may not be a reserved key. See CustomAttributeValidationUtils#isValidCustomAttributeKey

Parameters:

key - The identifier of the custom attribute

value - The double value of the custom attribute

Returns:

whether or not the custom user attribute was set correctly

addToCustomAttributeArray

public boolean addToCustomAttributeArray(java.lang.String key,
                                         java.lang.String value)

Adds a String to a custom attribute string array, or creates that array if one doesn't exist. The key and value parameters are limited to 255 characters in length. Keys and values which are too long will be truncated. Keys can only contain alphanumeric characters and underscores. Keys may not be a reserved key. See CustomAttributeValidationUtils#isValidCustomAttributeKey

Parameters:

key - The identifier of the custom attribute array

value - The String value of the custom attribute to be added to the array

Returns:

whether or not the custom user attribute array update was successfully logged

removeFromCustomAttributeArray

public boolean removeFromCustomAttributeArray(java.lang.String key,
                                              java.lang.String value)

Removes a string element from a custom attribute string array.

Parameters:

key - The identifier of the custom attribute array

value - The String value of the custom attribute to be removed from the array

Returns:

whether or not the custom user attribute array update was successfully logged

setCustomAttributeArray

public boolean setCustomAttributeArray(java.lang.String key,
                                       java.lang.String[] values)

Sets a String array of custom user attributes. This can be any array of key/value pairs and is used to collect extra information about the user. The key and value parameters are limited to 255 characters in length. Keys and values which are too long will be truncated. Keys can only contain alphanumeric characters and underscores. Keys may not be a reserved key. See CustomAttributeValidationUtils#isValidCustomAttributeKey To unset a custom attribute array, call unsetCustomUserAttribute(java.lang.String) with the key used to set the custom attribute array.

Parameters:

key - The identifier of the custom attribute array

values - The String[] array containing the custom attributes to be set

Returns:

whether or not the custom user attribute array update was successfully logged

setCustomUserAttributeToNow

public boolean setCustomUserAttributeToNow(java.lang.String key)

Sets a custom attribute with the given key to the current time. The key parameter is limited to 255 characters in length and can only contain alphanumeric characters and underscores. Keys which are too long will be truncated. Keys may not be a reserved key. See CustomAttributeValidationUtils#isValidCustomAttributeKey

Parameters:

key - The identifier of the custom attribute

Returns:

whether or not the custom user attribute was set correctly

setCustomUserAttributeToSecondsFromEpoch

public boolean setCustomUserAttributeToSecondsFromEpoch(java.lang.String key,
                                                        long secondsFromEpoch)

Sets a custom attribute to the given number of seconds elapsed since the epoch. The key parameter is limited to 255 characters in length and can only contain alphanumeric characters and underscores. Keys which are too long will be truncated. Keys may not be a reserved key. See CustomAttributeValidationUtils#isValidCustomAttributeKey

Parameters:

key - The identifier of the custom attribute

secondsFromEpoch - number of seconds elapsed since the epoch

Returns:

whether or not the custom user attribute was set correctly

incrementCustomUserAttribute

public boolean incrementCustomUserAttribute(java.lang.String key)

Increments the value of an custom attribute by one. Only integer and long custom attributes can be incremented. Attempting to increment a custom attribute that is not an integer or a long will be ignored. If you increment a custom attribute that has not previously been set, a custom attribute will be created and assigned a value of one.

Parameters:

key - The identifier of the custom attribute

incrementCustomUserAttribute

public boolean incrementCustomUserAttribute(java.lang.String key,
                                            int incrementValue)

Increments the value of an custom attribute by a given amount. Only integer and long custom attributes can be incremented. Attempting to increment a custom attribute that is not an integer or a long will be ignored. If you increment a custom attribute that has not previously been set, a custom attribute will be created and assigned the value of incrementValue. To decrement the value of a custom attribute, use a negative incrementValue.

Parameters:

key - The identifier of the custom attribute

incrementValue - The amount by which to increment the custom attribute

Returns:

whether or not the custom user attribute increment was successfully logged

unsetCustomUserAttribute

public boolean unsetCustomUserAttribute(java.lang.String key)

Removes the value associated with the given custom attribute key.

Parameters:

key - The identifier of the custom attribute

Returns:

whether or not the custom user attribute was unset correctly

setFacebookData

public boolean setFacebookData(FacebookUser facebookUserData)

Sets the Facebook profile data for this user. Multiple calls to this will result in a merged set of Facebook data where the most recent non-null, non-empty value for each field is persisted. Lists of Likes are not merged, the most recent list provided is used.

setTwitterData

public boolean setTwitterData(TwitterUser twitterUserData)

Sets the Twitter data for this user. Multiple calls to this will result in a merged set of Twitter data where the most recent non-null, non-empty value for each field is persisted.

setAttributionData

public boolean setAttributionData(AttributionData attributionData)

Sets attribution information for the user. For apps that have an install tracking integration.

setAvatarImageUrl

public boolean setAvatarImageUrl(java.lang.String avatarImageUrl)

Sets the Avatar image of the user which will be displayed on the user's profile on the dashboard.

Parameters:

avatarImageUrl - The url for user's avatar image. A null value will unset the avatar image url for this user.

getUserId

public java.lang.String getUserId()

Returns the currently tracked user id.

setLastKnownLocation

public void setLastKnownLocation(double latitude,
                                 double longitude,
                                 java.lang.Double altitude,
                                 java.lang.Double accuracy)

Sets the last known location for the user. Intended for use with BrazeConfig.Builder.setIsLocationCollectionEnabled(boolean) set to false in the `braze.xml` configuration file, so that the only locations being set are by the integrating app. Otherwise, calls to this method will be contending with automatic location update events.

latitude and longitude are required; altitude and accuracy may be set to null

Parameters:

latitude - The latitude of the User's location in degrees (valid values are between -90 to 90 degrees)

longitude - The longitude of the User's location (valid values are between -180 to 180 degrees)

altitude - The altitude of the User's location in meters above the WGS 84 reference ellipsoid

accuracy - The accuracy of the User's location in meters

setLocationCustomAttribute

public void setLocationCustomAttribute(java.lang.String key,
                                       double latitude,
                                       double longitude)

unsetLocationCustomAttribute

public void unsetLocationCustomAttribute(java.lang.String key)

setUserId

public void setUserId(java.lang.String userId)

Internal method. Do not call.