com.scvngr.levelup.core.net.request.factory

Class UserRequestFactory.UserInfoRequestBuilder

java.lang.Object

com.scvngr.levelup.core.net.request.factory.UserRequestFactory.UserInfoRequestBuilder

Enclosing class:

UserRequestFactory

@LevelUpApi(contract=ENTERPRISE)
public static final class UserRequestFactory.UserInfoRequestBuilder
extends Object

Builder to create a request that updates the User's information.

Constructor Summary

Constructors

Constructor and Description
UserInfoRequestBuilder(Context context, AccessTokenRetriever retriever) Creates a new builder for a UserRequestFactory request.

Method Summary

Modifier and Type	Method and Description
AbstractRequest	build() Builds the request which updates the User's information.
UserRequestFactory.UserInfoRequestBuilder	withBornAt(String bornAt) Adds the User's born at date information.
UserRequestFactory.UserInfoRequestBuilder	withCustomAttribute(String key, String value) Adds the User's custom attributes.
UserRequestFactory.UserInfoRequestBuilder	withEmail(String email) Adds the User's email address.
UserRequestFactory.UserInfoRequestBuilder	withFirstName(String firstName) Adds the User's first name.
UserRequestFactory.UserInfoRequestBuilder	withGender(String gender) Adds the User's gender information.
UserRequestFactory.UserInfoRequestBuilder	withLastName(String lastName) Adds the User's last name.
UserRequestFactory.UserInfoRequestBuilder	withNewPassword(String newPassword) Adds the User's new password.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserInfoRequestBuilder

public UserInfoRequestBuilder(Context context,
                              AccessTokenRetriever retriever)

Creates a new builder for a UserRequestFactory request.

Parameters:

context - The Application context.

retriever - the implementation of AccessTokenRetriever to use to get the User's AccessToken if needed.

Method Detail

build

@AccessTokenRequired
 @LevelUpApi(contract=ENTERPRISE)
public AbstractRequest build()

Builds the request which updates the User's information.

Returns:

The AbstractRequest which updates the User's information.

withBornAt

public UserRequestFactory.UserInfoRequestBuilder withBornAt(String bornAt)

Adds the User's born at date information. An empty or null attribute value removes the attribute's key from the pending update request.

Parameters:

bornAt - The born at date as an ISO date time.

Returns:

The UserRequestFactory.UserInfoRequestBuilder for chaining convenience.

withCustomAttribute

public UserRequestFactory.UserInfoRequestBuilder withCustomAttribute(String key,
                                                                     String value)

Adds the User's custom attributes. An empty or null custom attribute value removes the custom attribute's key from the pending update request. The request is not modified if the custom attribute set is null.

Parameters:

key - The custom attribute key.

value - The custom attribute value.

Returns:

The UserRequestFactory.UserInfoRequestBuilder for chaining convenience.

withEmail

public UserRequestFactory.UserInfoRequestBuilder withEmail(String email)

Adds the User's email address. An empty or null attribute value removes the attribute's key from the pending update request.

Parameters:

email - The User's email address.

Returns:

The UserRequestFactory.UserInfoRequestBuilder for chaining convenience.

withFirstName

public UserRequestFactory.UserInfoRequestBuilder withFirstName(String firstName)

Adds the User's first name. An empty or null attribute value removes the attribute's key from the pending update request.

Parameters:

firstName - The User's first name.

Returns:

The UserRequestFactory.UserInfoRequestBuilder for chaining convenience.

withGender

public UserRequestFactory.UserInfoRequestBuilder withGender(String gender)

Adds the User's gender information. An empty or null attribute value removes the attribute's key from the pending update request.

Parameters:

gender - The gender string generated by User.Gender.toString() .

Returns:

The UserRequestFactory.UserInfoRequestBuilder for chaining convenience.

withLastName

public UserRequestFactory.UserInfoRequestBuilder withLastName(String lastName)

Adds the User's last name. An empty or null attribute value removes the attribute's key from the pending update request.

Parameters:

lastName - The User's last name.

Returns:

The UserRequestFactory.UserInfoRequestBuilder for chaining convenience.

withNewPassword

public UserRequestFactory.UserInfoRequestBuilder withNewPassword(String newPassword)

Adds the User's new password. An empty or null attribute value removes the attribute's key from the pending update request.

Parameters:

newPassword - The User's new password or null if the password is not being modified.

Returns:

The UserRequestFactory.UserInfoRequestBuilder for chaining convenience.