com.scvngr.levelup.core.model

Class User

java.lang.Object

com.scvngr.levelup.core.model.User

All Implemented Interfaces:

Parcelable

@Immutable
 @LevelUpApi(contract=PUBLIC)
public final class User
extends Object
implements Parcelable

Represents the user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.Gender Represents selectable options for the user's gender (an optional field).
static class	User.UserBuilder

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<User>	CREATOR Implements the Parcelable interface.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
User(String bornAt, boolean isConnectedToFacebook, Map<String,String> customAttributes, boolean isDebitCardOnly, String email, String firstName, User.Gender gender, MonetaryValue globalCredit, Long id, String lastName, int merchantsVisitedCount, int ordersCount, String termsAcceptedAt, MonetaryValue totalSavings)

Method Summary

Modifier and Type	Method and Description
static User.UserBuilder	builder()
int	describeContents()
boolean	equals(Object o)
String	getBornAt() The timestamp when the user was born.
Map<String,String>	getCustomAttributes() A map of custom attributes for the user.
String	getEmail() The user's email address.
String	getFirstName() The user's first name.
User.Gender	getGender() The user's gender.
MonetaryValue	getGlobalCredit() The amount of global credit the user has.
Long	getId() The user's web service ID.
String	getLastName() The user's last name.
int	getMerchantsVisitedCount() The number of merchants the user has visited.
int	getOrdersCount() The user's total number of orders placed on LevelUp.
String	getTermsAcceptedAt() The time the user accepted the LevelUp terms and conditions.
MonetaryValue	getTotalSavings() The total amount the user has saved by using LevelUp.
int	hashCode()
boolean	isConnectedToFacebook() Determines whether the user is connected to Facebook.
boolean	isDebitCardOnly() Determines whether the user is only allowed to link debit cards.
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<User> CREATOR

Implements the Parcelable interface.

Constructor Detail

User

public User(String bornAt,
            boolean isConnectedToFacebook,
            Map<String,String> customAttributes,
            boolean isDebitCardOnly,
            String email,
            String firstName,
            User.Gender gender,
            MonetaryValue globalCredit,
            Long id,
            String lastName,
            int merchantsVisitedCount,
            int ordersCount,
            String termsAcceptedAt,
            MonetaryValue totalSavings)

Parameters:

bornAt - the timestamp when the user was born.

isConnectedToFacebook - determines whether the user is connected to Facebook.

customAttributes - map of custom attributes for the user.

isDebitCardOnly - determines whether the user is only allowed to link debit cards.

email - the user's email address.

firstName - the user's first name.

gender - the user's gender.

globalCredit - the amount of global credit the user has.

id - the user's web service ID.

lastName - the user's last name.

merchantsVisitedCount - the number of merchants the user has visited.

ordersCount - the user's total number of orders placed on LevelUp.

termsAcceptedAt - the time the user accepted the LevelUp terms and conditions.

totalSavings - the total amount the user has saved by using LevelUp.

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

builder

public static User.UserBuilder builder()

getBornAt

public String getBornAt()

The timestamp when the user was born.

isConnectedToFacebook

public boolean isConnectedToFacebook()

Determines whether the user is connected to Facebook.

getCustomAttributes

public Map<String,String> getCustomAttributes()

A map of custom attributes for the user.

isDebitCardOnly

public boolean isDebitCardOnly()

Determines whether the user is only allowed to link debit cards.

getEmail

public String getEmail()

The user's email address.

getFirstName

public String getFirstName()

The user's first name.

getGender

public User.Gender getGender()

The user's gender.

getGlobalCredit

public MonetaryValue getGlobalCredit()

The amount of global credit the user has.

getId

public Long getId()

The user's web service ID.

getLastName

public String getLastName()

The user's last name.

getMerchantsVisitedCount

public int getMerchantsVisitedCount()

The number of merchants the user has visited. Parsed with a 0 default.

getOrdersCount

public int getOrdersCount()

The user's total number of orders placed on LevelUp. Parsed with a 0 default.

getTermsAcceptedAt

public String getTermsAcceptedAt()

The time the user accepted the LevelUp terms and conditions.

getTotalSavings

public MonetaryValue getTotalSavings()

The total amount the user has saved by using LevelUp.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object