com.microstrategy.ushersdk

Class UserEntity

java.lang.Object

com.microstrategy.ushersdk.UserEntity

@Generated(value="com.robohorse.robopojogenerator")
public abstract class UserEntity
extends java.lang.Object

The UserEntity abstract class wraps all of the properties related to the user account.

Method Summary

Modifier and Type	Method and Description
static com.microstrategy.ushersdk.UserEntity.Builder	builder() Returns the Builder object for the UserEntity abstract class.
abstract java.lang.String	city() Returns a String of the user's city of residence.
abstract java.lang.String	country() Returns a String of the user's country of residence.
abstract java.lang.String	email() Returns a String of the user's email address.
abstract boolean	emailVerified() Returns a boolean that represents whether or not the user's email address has been verified.
abstract java.util.Map<java.lang.String,java.lang.Object>	extra() Returns the Map that contains the extra information.
abstract java.lang.String	firstName() Returns a String of the user's first name.
abstract java.lang.String	lastName() Returns a String of the user's last name.
abstract java.lang.String	mobile() Returns a String of the user's mobile phone number.
abstract boolean	mobileVerified() Returns a boolean that represents whether or not the user's mobile phone number has been verified.
abstract java.lang.String	state() Returns a String of the user's state of residence.
abstract java.lang.String	street1() Returns a String of the user's primary address.
abstract java.lang.String	street2() Returns a String of the user's secondary address.
abstract java.lang.String	uid() Returns a String of the user's Usher ID.
abstract UserSettingsEntity	userSettings() Returns the UserSettingsEntity object that wraps various properties related to user settings.
abstract UserEntity	withUserSettings(UserSettingsEntity userSettings) Constructor for a UserEntity object with the userSettings set.
abstract java.lang.String	zip() Returns a String of the user's ZIP Code.

Methods inherited from class java.lang.Object

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

Method Detail

city

@Nullable
 @SerializedName(value="city")
public abstract java.lang.String city()

Returns a String of the user's city of residence. May be null.

Returns:

the user's city of residence.

country

@Nullable
 @SerializedName(value="country")
public abstract java.lang.String country()

Returns a String of the user's country of residence. May be null.

Returns:

the user's country of residence.

email

@SerializedName(value="email")
public abstract java.lang.String email()

Returns a String of the user's email address.

Returns:

the user's email address.

emailVerified

@SerializedName(value="emailVerified")
public abstract boolean emailVerified()

Returns a boolean that represents whether or not the user's email address has been verified.

Returns:

true if the user's email address has been verified; false otherwise.

firstName

@SerializedName(value="firstName")
public abstract java.lang.String firstName()

Returns a String of the user's first name.

Returns:

the user's first name.

lastName

@SerializedName(value="lastName")
public abstract java.lang.String lastName()

Returns a String of the user's last name.

Returns:

the user's last name.

mobile

@SerializedName(value="mobile")
public abstract java.lang.String mobile()

Returns a String of the user's mobile phone number.

Returns:

the user's mobile phone number.

mobileVerified

@SerializedName(value="mobileVerified")
public abstract boolean mobileVerified()

Returns a boolean that represents whether or not the user's mobile phone number has been verified.

Returns:

true if the user's mobile phone number has been verified; false otherwise.

state

@Nullable
 @SerializedName(value="state")
public abstract java.lang.String state()

Returns a String of the user's state of residence. May be null.

Returns:

the user's state of residence.

street1

@Nullable
 @SerializedName(value="street1")
public abstract java.lang.String street1()

Returns a String of the user's primary address. May be null.

Returns:

the user's primary address.

street2

@Nullable
 @SerializedName(value="street2")
public abstract java.lang.String street2()

Returns a String of the user's secondary address. This may include information such as apartment number and/or floor number. May be null.

Returns:

the user's secondary address.

uid

@SerializedName(value="uid")
public abstract java.lang.String uid()

Returns a String of the user's Usher ID.

Returns:

the user's Usher ID.

zip

@Nullable
 @SerializedName(value="zip")
public abstract java.lang.String zip()

Returns a String of the user's ZIP Code. May be null.

Returns:

the user's ZIP Code.

extra

@Nullable
public abstract java.util.Map<java.lang.String,java.lang.Object> extra()

Returns the Map that contains the extra information. May be null.

Returns:

the extra information that you would like to send to server.

userSettings

@Nullable
public abstract UserSettingsEntity userSettings()

Returns the UserSettingsEntity object that wraps various properties related to user settings. May be null.

Returns:

the UserSettingsEntity object that wraps various properties related to user settings.

withUserSettings

public abstract UserEntity withUserSettings(UserSettingsEntity userSettings)

Constructor for a UserEntity object with the userSettings set.

Parameters:

userSettings - See userSettings()

Returns:

a UserEntity object with the userSettings set.

builder

public static com.microstrategy.ushersdk.UserEntity.Builder builder()

Returns the Builder object for the UserEntity abstract class.

Returns:

the Builder object for the UserEntity abstract class.