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

Class UserRequestFactory

java.lang.Object

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

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

@Immutable
 @LevelUpApi(contract=PUBLIC)
public final class UserRequestFactory
extends AbstractRequestFactory

Class to build requests to interact with the endpoints that deal with Users.

If you're looking to login, see AccessTokenRequestFactory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserRequestFactory.UserInfoRequestBuilder Builder to create a request that updates the User's information.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OUTER_PARAM_PERMISSION_KEYNAMES Outer parameter name for permission keynames parameters.
static String	OUTER_PARAM_USER Outer parameter name for user parameters.
static String	PARAM_BORN_AT User Parameter for birth date.
static String	PARAM_CUSTOM_ATTRIBUTES User Parameter for custom attributes.
static String	PARAM_EMAIL User Parameter for email.
static String	PARAM_FIRST_NAME User Parameter for first name.
static String	PARAM_GENDER User Parameter for gender.
static String	PARAM_LAST_NAME User Parameter for last name.
static String	PARAM_LATITUDE User Parameter for latitude, represented as a floating point number.
static String	PARAM_LONGITUDE User Parameter for longitude, represented as a floating point number.
static String	PARAM_NEW_PASSWORD User Parameter for new password.
static String	PARAM_NEW_PASSWORD_CONFIRMATION User Parameter for new password confirmation.
static String	PARAM_PASSWORD User Parameter for password.
static String	PARAM_TERMS_ACCEPTED User Parameter for if they have accepted the terms of service.

Constructor Summary

Constructors

Constructor and Description
UserRequestFactory(Context context, AccessTokenRetriever retriever)

Method Summary

Modifier and Type	Method and Description
AbstractRequest	buildFacebookConnectRequest(String facebookAccessToken) Builds a request to connect a user to Facebook.
AbstractRequest	buildFacebookDisconnectRequest() Builds a request to disconnect a user from Facebook.
AbstractRequest	buildFacebookRegisterRequest(String facebookAccessToken) Build a request to register a new User via a facebook access token.
AbstractRequest	buildForgotPasswordRequest(String email) Get a request that will allow the user to reset their password.
AbstractRequest	buildGetUserInfoRequest() Build a request to retrieve the User information.
AbstractRequest	buildRegisterRequest(String firstName, String lastName, String email, List<String> permissions) Build a request to create a new user.
AbstractRequest	buildRegisterRequest(String firstName, String lastName, String email, String password, Location location) Build a request to create a new user.

Methods inherited from class com.scvngr.levelup.core.net.request.factory.AbstractRequestFactory

getAccessTokenRetriever, getContext

Methods inherited from class java.lang.Object

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

Field Detail

OUTER_PARAM_USER

public static final String OUTER_PARAM_USER

Outer parameter name for user parameters.

See Also:

Constant Field Values

OUTER_PARAM_PERMISSION_KEYNAMES

public static final String OUTER_PARAM_PERMISSION_KEYNAMES

Outer parameter name for permission keynames parameters.

See Also:

Constant Field Values

PARAM_LONGITUDE

public static final String PARAM_LONGITUDE

User Parameter for longitude, represented as a floating point number.

See Also:

Constant Field Values

PARAM_LATITUDE

public static final String PARAM_LATITUDE

User Parameter for latitude, represented as a floating point number.

See Also:

Constant Field Values

PARAM_PASSWORD

public static final String PARAM_PASSWORD

User Parameter for password.

See Also:

Constant Field Values

PARAM_NEW_PASSWORD

public static final String PARAM_NEW_PASSWORD

User Parameter for new password.

See Also:

Constant Field Values

PARAM_NEW_PASSWORD_CONFIRMATION

public static final String PARAM_NEW_PASSWORD_CONFIRMATION

User Parameter for new password confirmation.

See Also:

Constant Field Values

PARAM_EMAIL

public static final String PARAM_EMAIL

User Parameter for email.

See Also:

Constant Field Values

PARAM_LAST_NAME

public static final String PARAM_LAST_NAME

User Parameter for last name.

See Also:

Constant Field Values

PARAM_FIRST_NAME

public static final String PARAM_FIRST_NAME

User Parameter for first name.

See Also:

Constant Field Values

PARAM_TERMS_ACCEPTED

public static final String PARAM_TERMS_ACCEPTED

User Parameter for if they have accepted the terms of service.

See Also:

Constant Field Values

PARAM_BORN_AT

public static final String PARAM_BORN_AT

User Parameter for birth date.

See Also:

Constant Field Values

PARAM_GENDER

public static final String PARAM_GENDER

User Parameter for gender.

See Also:

Constant Field Values

PARAM_CUSTOM_ATTRIBUTES

public static final String PARAM_CUSTOM_ATTRIBUTES

User Parameter for custom attributes.

See Also:

Constant Field Values

Constructor Detail

UserRequestFactory

public UserRequestFactory(Context context,
                          AccessTokenRetriever retriever)

Parameters:

context - the Application context.

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

Method Detail

buildForgotPasswordRequest

@LevelUpApi(contract=ENTERPRISE)
public AbstractRequest buildForgotPasswordRequest(String email)

Get a request that will allow the user to reset their password.

Parameters:

email - the email address they signed up with.

Returns:

AbstractRequest to use to reset the password for the user.

buildFacebookConnectRequest

@LevelUpApi(contract=INTERNAL)
 @AccessTokenRequired
public AbstractRequest buildFacebookConnectRequest(String facebookAccessToken)

Builds a request to connect a user to Facebook.

Parameters:

facebookAccessToken - the Facebook access token to use to connect the user.

Returns:

AbstractRequest to use to connect the user to Facebook.

buildFacebookDisconnectRequest

@LevelUpApi(contract=INTERNAL)
 @AccessTokenRequired
public AbstractRequest buildFacebookDisconnectRequest()

Builds a request to disconnect a user from Facebook.

Returns:

AbstractRequest to use to disconnect the user from Facebook.

buildRegisterRequest

@LevelUpApi(contract=ENTERPRISE)
public final AbstractRequest buildRegisterRequest(String firstName,
                                                                                   String lastName,
                                                                                   String email,
                                                                                   String password,
                                                                                   Location location)

Build a request to create a new user. Will also get the device UUID and append it to the request.

Parameters:

firstName - user's first name.

lastName - user's last name.

email - user's email address.

password - user's new password.

location - Android Location for the user (or null if none was found).

Returns:

AbstractRequest representing the register request.

buildRegisterRequest

@LevelUpApi(contract=PUBLIC)
public final AbstractRequest buildRegisterRequest(String firstName,
                                                                               String lastName,
                                                                               String email,
                                                                               List<String> permissions)

Build a request to create a new user.

Parameters:

firstName - user's first name.

lastName - user's last name.

email - user's email address.

permissions - array of permissions to grant the new user

Returns:

AbstractRequest representing the register request.

buildFacebookRegisterRequest

@LevelUpApi(contract=INTERNAL)
public AbstractRequest buildFacebookRegisterRequest(String facebookAccessToken)

Build a request to register a new User via a facebook access token.

Parameters:

facebookAccessToken - the facebook access token to use to register the new user.

Returns:

the AbstractRequest to use to register the new user.

buildGetUserInfoRequest

@AccessTokenRequired
 @LevelUpApi(contract=PUBLIC)
 @RequiresPermission(value="read_user_basic_info")
public AbstractRequest buildGetUserInfoRequest()

Build a request to retrieve the User information.

Returns:

the request to retrieve the user information.