com.baasbox.android

Class BaasUser

java.lang.Object

com.baasbox.android.BaasUser

All Implemented Interfaces:

android.os.Parcelable

public class BaasUser
extends java.lang.Object
implements android.os.Parcelable

Represents a User of the BaasBox service.

You can create a new instance through the factory method BaasUser.withUserName(String)

Users have associated profile data with different levels of visibility as specified by BaasUser.Scope.

Accounts on BaasBox are managed through this class BaasUser.signup(BaasHandler) BaasUser.login(String, BaasHandler) and BaasUser.logout(BaasHandler) family of methods, and their *sync counterpart.

The currently logged in user can be retrieved through BaasUser.current(), and it is the only one that is modifiable.

BaasUser also exposes methods to handle friendship, through BaasUser.follow(BaasHandler)/BaasUser.unfollow(BaasHandler) and direct gcm messaging throuhg #send(com.baasbox.android.json.JsonObject, BaasHandler)

In any other respect users are treated similarly to other resources exposed by the server.

Created by Andrea Tortorella on 02/01/14.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaasUser.Scope Scopes of visibility of user related data.
static class	BaasUser.Social

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<BaasUser>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
RequestToken	changePassword(java.lang.String password, BaasHandler<java.lang.Void> handler)
RequestToken	changePassword(java.lang.String password, int flags, BaasHandler<java.lang.Void> handler)
BaasResult<java.lang.Void>	changePasswordSync(java.lang.String password)
static BaasUser	current() Returns the current logged in user if one is logged in or null
int	describeContents()
boolean	equals(java.lang.Object o)
static RequestToken	fetch(java.lang.String username, BaasHandler<BaasUser> handler) Asynchronously fetches an existing BaasUser from the server given it's username.
static RequestToken	fetch(java.lang.String username, int flags, BaasHandler<BaasUser> handler) Asynchronously fetches an existing BaasUser from the server given it's username
static RequestToken	fetchAll(BaasHandler<java.util.List<BaasUser>> handler) Asynchronously fetches the list of users from the server.
static RequestToken	fetchAll(BaasQuery.Criteria filter, BaasHandler<java.util.List<BaasUser>> handler) Asynchronously fetches the list of users from the server.
static RequestToken	fetchAll(BaasQuery.Criteria filter, int flags, BaasHandler<java.util.List<BaasUser>> handler) Asynchronously fetches the list of users from the server.
static BaasResult<java.util.List<BaasUser>>	fetchAllSync()
static BaasResult<java.util.List<BaasUser>>	fetchAllSync(BaasQuery.Criteria filter)
RequestToken	fetchLinkedSocialNetworks(BaasHandler<JsonArray> handler)
RequestToken	fetchLinkedSocialNetworks(int flags, BaasHandler<JsonArray> handler)
BaasResult<JsonArray>	fetchLinkedSocialNetworksSync()
static BaasResult<BaasUser>	fetchSync(java.lang.String username)
RequestToken	follow(BaasHandler<BaasUser> handler) Asynchronously requests to follow the user.
RequestToken	follow(int flags, BaasHandler<BaasUser> handler) Asynchronously requests to follow the user.
RequestToken	followers(BaasHandler<java.util.List<BaasUser>> handler)
RequestToken	followers(BaasQuery.Criteria filter, BaasHandler<java.util.List<BaasUser>> handler)
RequestToken	followers(BaasQuery.Criteria filter, int flags, BaasHandler<java.util.List<BaasUser>> handler)
BaasResult<java.util.List<BaasUser>>	followersSync()
BaasResult<java.util.List<BaasUser>>	followersSync(BaasQuery.Criteria filter)
RequestToken	following(BaasHandler<java.util.List<BaasUser>> handler)
RequestToken	following(BaasQuery.Criteria filter, BaasHandler<java.util.List<BaasUser>> handler)
RequestToken	following(BaasQuery.Criteria filter, int flags, BaasHandler<java.util.List<BaasUser>> handler)
BaasResult<java.util.List<BaasUser>>	followingSync()
BaasResult<java.util.List<BaasUser>>	followingSync(BaasQuery.Criteria filter)
BaasResult<BaasUser>	followSync()
java.lang.String	getName() Returns the name of the user.
java.lang.String	getPassword() Returns the password of this user, if there is one.
java.util.Set<java.lang.String>	getRoles() Returns an unmodifialble set of the roles to which the user belongs if it's available
JsonObject	getScope(BaasUser.Scope scope) Returns data associate to this user for the specific scope as a JsonObject.
java.lang.String	getSignupDate() Returns the signupdate for this user if available or null.
java.lang.String	getStatus() Returns the registration status of the user if available or null.
java.lang.String	getToken() Returns the authtoken used by this user.
int	hashCode()
boolean	hasRole(java.lang.String role) Checks if the user has a specific role
static boolean	isAuthentcated() Verifies if there is a currently logged in user on this device
boolean	isCurrent() Checks if this user is the currently logged in user on this device.
RequestToken	linkToProvider(java.lang.String provider, java.lang.String token, java.lang.String secret, BaasHandler<JsonObject> handler)
RequestToken	linkToProvider(java.lang.String provider, java.lang.String token, java.lang.String secret, int flags, BaasHandler<JsonObject> handler)
BaasResult<JsonObject>	linkToProviderSync(java.lang.String provider, java.lang.String token, java.lang.String secret)
RequestToken	login(BaasHandler<BaasUser> handler) Asynchronously logins this user.
RequestToken	login(java.lang.String registrationId, BaasHandler<BaasUser> handler) Asynchronously logins this user with password and registrationId obtained through gcm.
RequestToken	login(java.lang.String regitrationId, int flags, BaasHandler<BaasUser> handler) Asynchronously logins the user with password and registrationId obtained through gcm.
BaasResult<BaasUser>	loginSync() Synchronously logins the user with password.
BaasResult<BaasUser>	loginSync(java.lang.String registrationId) Synchronously logins the user with password and registrationId obtained through gcm.
RequestToken	logout(BaasHandler<java.lang.Void> handler) Logouts the user from the server.
RequestToken	logout(java.lang.String registration, BaasHandler<java.lang.Void> handler) Logouts the user from the specific device.
RequestToken	logout(java.lang.String registration, int flags, BaasHandler<java.lang.Void> handler) Logouts the user from the specific device.
BaasResult<java.lang.Void>	logoutSync() Sychronously logouts current user from the server
BaasResult<java.lang.Void>	logoutSync(java.lang.String registration) Synchronously logouts current user from the server.
RequestToken	refresh(BaasHandler<BaasUser> handler)
RequestToken	refresh(int flags, BaasHandler<BaasUser> handler)
BaasResult<BaasUser>	refreshSync()
static RequestToken	requestPasswordReset(java.lang.String username, int flags, BaasHandler<java.lang.Void> handler)
static BaasResult<java.lang.Void>	requestPasswordResetSync(java.lang.String username)
static RequestToken	requestPaswordReset(java.lang.String username, BaasHandler<java.lang.Void> handler)
RequestToken	save(BaasHandler<BaasUser> handler) Asynchronously saves the updates made to the current user.
RequestToken	save(int flags, BaasHandler<BaasUser> handler) Asynchronously saves the updates made to the current user.
BaasResult<BaasUser>	saveSync() Synchronously saves the updates made to the current user.
BaasUser	setPassword(java.lang.String password) Sets the password for this user.
RequestToken	signup(BaasHandler<BaasUser> handler) Asynchronously signups this user to baasbox using provided password and default RequestOptions
RequestToken	signup(int flags, BaasHandler<BaasUser> handler) Asynchronously signups this user to baasbox using provided password and priority
BaasResult<BaasUser>	signupSync() Synchronously signups this user to BaasBox.
static RequestToken	signupWithProvider(java.lang.String provider, java.lang.String token, java.lang.String secret, BaasHandler<BaasUser> handler)
static RequestToken	signupWithProvider(java.lang.String provider, java.lang.String token, java.lang.String secret, int flags, BaasHandler<BaasUser> handler)
static BaasResult<BaasUser>	signupWithProviderSync(java.lang.String provider, java.lang.String token, java.lang.String secret)
java.lang.String	toString()
RequestToken	unfollow(BaasHandler<BaasUser> user)
RequestToken	unfollow(int flags, BaasHandler<BaasUser> handler) Asynchronously requests to unfollow the user
BaasResult<BaasUser>	unfollowSync()
RequestToken	unlinkFromProvider(java.lang.String provider, BaasHandler<java.lang.Void> handler)
RequestToken	unlinkFromProvider(java.lang.String provider, int flags, BaasHandler<java.lang.Void> handler)
BaasResult<java.lang.Void>	unlinkFromProviderSync(java.lang.String provider)
static BaasUser	withUserName(java.lang.String username) Creates a new user bound to username.
void	writeToParcel(android.os.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 android.os.Parcelable.Creator<BaasUser> CREATOR

Method Detail

isAuthentcated

public static boolean isAuthentcated()

Verifies if there is a currently logged in user on this device

Returns:

true if there is an authenticated user on this device

current

public static BaasUser current()

Returns the current logged in user if one is logged in or null

Returns:

the current logged in BaasUser

signupWithProviderSync

public static BaasResult<BaasUser> signupWithProviderSync(java.lang.String provider,
                                                          java.lang.String token,
                                                          java.lang.String secret)

signupWithProvider

public static RequestToken signupWithProvider(java.lang.String provider,
                                              java.lang.String token,
                                              java.lang.String secret,
                                              BaasHandler<BaasUser> handler)

signupWithProvider

public static RequestToken signupWithProvider(java.lang.String provider,
                                              java.lang.String token,
                                              java.lang.String secret,
                                              int flags,
                                              BaasHandler<BaasUser> handler)

linkToProvider

public RequestToken linkToProvider(java.lang.String provider,
                                   java.lang.String token,
                                   java.lang.String secret,
                                   int flags,
                                   BaasHandler<JsonObject> handler)

linkToProvider

public RequestToken linkToProvider(java.lang.String provider,
                                   java.lang.String token,
                                   java.lang.String secret,
                                   BaasHandler<JsonObject> handler)

linkToProviderSync

public BaasResult<JsonObject> linkToProviderSync(java.lang.String provider,
                                                 java.lang.String token,
                                                 java.lang.String secret)

unlinkFromProvider

public RequestToken unlinkFromProvider(java.lang.String provider,
                                       int flags,
                                       BaasHandler<java.lang.Void> handler)

unlinkFromProvider

public RequestToken unlinkFromProvider(java.lang.String provider,
                                       BaasHandler<java.lang.Void> handler)

unlinkFromProviderSync

public BaasResult<java.lang.Void> unlinkFromProviderSync(java.lang.String provider)

fetchLinkedSocialNetworks

public RequestToken fetchLinkedSocialNetworks(int flags,
                                              BaasHandler<JsonArray> handler)

fetchLinkedSocialNetworks

public RequestToken fetchLinkedSocialNetworks(BaasHandler<JsonArray> handler)

fetchLinkedSocialNetworksSync

public BaasResult<JsonArray> fetchLinkedSocialNetworksSync()

requestPasswordResetSync

public static BaasResult<java.lang.Void> requestPasswordResetSync(java.lang.String username)

requestPaswordReset

public static RequestToken requestPaswordReset(java.lang.String username,
                                               BaasHandler<java.lang.Void> handler)

requestPasswordReset

public static RequestToken requestPasswordReset(java.lang.String username,
                                                int flags,
                                                BaasHandler<java.lang.Void> handler)

fetch

public static RequestToken fetch(java.lang.String username,
                                 BaasHandler<BaasUser> handler)

Asynchronously fetches an existing BaasUser from the server given it's username.

Parameters:

username - a non empty username

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to manage the request

withUserName

public static BaasUser withUserName(java.lang.String username)

Creates a new user bound to username. If the provided username is the same one of the currently logged in account the same instance of BaasUser.current() is returned.

Parameters:

username - a non empty username

Returns:

a BaasUser

refresh

public RequestToken refresh(BaasHandler<BaasUser> handler)

fetch

public static RequestToken fetch(java.lang.String username,
                                 int flags,
                                 BaasHandler<BaasUser> handler)

Asynchronously fetches an existing BaasUser from the server given it's username

Parameters:

username - a non empty username

flags - RequestOptions

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to manage the request

refresh

public RequestToken refresh(int flags,
                            BaasHandler<BaasUser> handler)

fetchSync

public static BaasResult<BaasUser> fetchSync(java.lang.String username)

refreshSync

public BaasResult<BaasUser> refreshSync()

fetchAllSync

public static BaasResult<java.util.List<BaasUser>> fetchAllSync()

fetchAllSync

public static BaasResult<java.util.List<BaasUser>> fetchAllSync(BaasQuery.Criteria filter)

fetchAll

public static RequestToken fetchAll(BaasHandler<java.util.List<BaasUser>> handler)

Asynchronously fetches the list of users from the server.

Parameters:

handler - an handler to be invoked upon completion of the request

Returns:

a RequestToken to manage the request

fetchAll

public static RequestToken fetchAll(BaasQuery.Criteria filter,
                                    BaasHandler<java.util.List<BaasUser>> handler)

Asynchronously fetches the list of users from the server.

Parameters:

filter - an optional filter to apply to the request

handler - an handler to be invoked upon completion of the request

Returns:

a RequestToken to manage the request

fetchAll

public static RequestToken fetchAll(BaasQuery.Criteria filter,
                                    int flags,
                                    BaasHandler<java.util.List<BaasUser>> handler)

Asynchronously fetches the list of users from the server.

Parameters:

flags - RequestOptions

handler - an handler to be invoked upon completion of the request

Returns:

a RequestToken to manage the request

getPassword

public java.lang.String getPassword()

Returns the password of this user, if there is one.

Returns:

a String representing the password of the user.

getSignupDate

public java.lang.String getSignupDate()

Returns the signupdate for this user if available or null.

Returns:

the signup date

getStatus

public java.lang.String getStatus()

Returns the registration status of the user if available or null.

Returns:

a string representing the status of the user

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

changePassword

public RequestToken changePassword(java.lang.String password,
                                   BaasHandler<java.lang.Void> handler)

changePassword

public RequestToken changePassword(java.lang.String password,
                                   int flags,
                                   BaasHandler<java.lang.Void> handler)

changePasswordSync

public BaasResult<java.lang.Void> changePasswordSync(java.lang.String password)

follow

public RequestToken follow(BaasHandler<BaasUser> handler)

Asynchronously requests to follow the user.

Parameters:

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to manage the request

follow

public RequestToken follow(int flags,
                           BaasHandler<BaasUser> handler)

Asynchronously requests to follow the user.

Parameters:

flags - RequestOptions

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to manage the request

followSync

public BaasResult<BaasUser> followSync()

followers

public RequestToken followers(BaasHandler<java.util.List<BaasUser>> handler)

followers

public RequestToken followers(BaasQuery.Criteria filter,
                              BaasHandler<java.util.List<BaasUser>> handler)

followers

public RequestToken followers(BaasQuery.Criteria filter,
                              int flags,
                              BaasHandler<java.util.List<BaasUser>> handler)

isCurrent

public boolean isCurrent()

Checks if this user is the currently logged in user on this device.

Returns:

true if this == BaasUser.current()

getName

public java.lang.String getName()

Returns the name of the user.

Returns:

the name of the user.

followersSync

public BaasResult<java.util.List<BaasUser>> followersSync()

followersSync

public BaasResult<java.util.List<BaasUser>> followersSync(BaasQuery.Criteria filter)

following

public RequestToken following(BaasHandler<java.util.List<BaasUser>> handler)

following

public RequestToken following(BaasQuery.Criteria filter,
                              BaasHandler<java.util.List<BaasUser>> handler)

following

public RequestToken following(BaasQuery.Criteria filter,
                              int flags,
                              BaasHandler<java.util.List<BaasUser>> handler)

followingSync

public BaasResult<java.util.List<BaasUser>> followingSync()

followingSync

public BaasResult<java.util.List<BaasUser>> followingSync(BaasQuery.Criteria filter)

getRoles

public java.util.Set<java.lang.String> getRoles()

Returns an unmodifialble set of the roles to which the user belongs if it's available

Returns:

a Set of role names

getScope

public JsonObject getScope(BaasUser.Scope scope)

Returns data associate to this user for the specific scope as a JsonObject. If the data is not visible to the current logged in user returns null.

The returned JsonObject should be treated as read-only unless the user to whom belongs is the current user as per BaasUser.isCurrent().

Parameters:

scope - a scope BaasUser.Scope not null

Returns:

JsonObject or null if the data is not visible.

Throws:

java.lang.NullPointerException - if scope is null

getToken

public java.lang.String getToken()

Returns the authtoken used by this user. This will be non null only if the user is the current one.

Returns:

a String token

hasRole

public boolean hasRole(java.lang.String role)

Checks if the user has a specific role

Parameters:

role - a role name

Returns:

true if the user is known to belong to role

Throws:

java.lang.NullPointerException - if role is null

login

public RequestToken login(BaasHandler<BaasUser> handler)

Asynchronously logins this user. The handler will be invoked upon completion of the request.

Parameters:

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to handle the async request

login

public RequestToken login(java.lang.String registrationId,
                          BaasHandler<BaasUser> handler)

Asynchronously logins this user with password and registrationId obtained through gcm. The handler will be invoked upon completion of the request.

Parameters:

registrationId - a registration id for gcm

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to handle the async request

login

public RequestToken login(java.lang.String regitrationId,
                          int flags,
                          BaasHandler<BaasUser> handler)

Asynchronously logins the user with password and registrationId obtained through gcm. The handler will be invoked upon completion of the request. The request is executed at the gien priority.

Parameters:

regitrationId - the registrationId

flags - RequestOptions

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to handle the async request

loginSync

public BaasResult<BaasUser> loginSync()

Synchronously logins the user with password.

Returns:

the result of the request

loginSync

public BaasResult<BaasUser> loginSync(java.lang.String registrationId)

Synchronously logins the user with password and registrationId obtained through gcm.

Parameters:

registrationId - a registration id for gcm

Returns:

the result of the request

logout

public RequestToken logout(BaasHandler<java.lang.Void> handler)

Logouts the user from the server. After this call completes no current user is available. BaasUser.current() will return null.

Parameters:

handler - an handler to be invoked upon completion of the request

Returns:

a RequestToken to handle the async request

logout

public RequestToken logout(java.lang.String registration,
                           BaasHandler<java.lang.Void> handler)

Logouts the user from the specific device. After this call completes no current user is available. BaasUser.current() will return null. And on this device the user will not receive any new message from google cloud messaging.

Parameters:

registration - a registration id to remove

handler - an handler to be invoked upon completion of the request

Returns:

a RequestToken to handle the async request

logout

public RequestToken logout(java.lang.String registration,
                           int flags,
                           BaasHandler<java.lang.Void> handler)

Logouts the user from the specific device. After this call completes no current user is available. BaasUser.current() will return null. And on this device the user will not receive any new message from google cloud messaging.

Parameters:

registration - a registration id to remove

flags - RequestOptions

handler - an handler to be invoked upon completion of the request

Returns:

a RequestToken to handle the async request

logoutSync

public BaasResult<java.lang.Void> logoutSync()

Sychronously logouts current user from the server

Returns:

the result of the request

logoutSync

public BaasResult<java.lang.Void> logoutSync(java.lang.String registration)

Synchronously logouts current user from the server.

Parameters:

registration - a registration id to remove

Returns:

the result of the request

save

public RequestToken save(BaasHandler<BaasUser> handler)

Asynchronously saves the updates made to the current user.

Parameters:

handler - an handler to be invoked when the request completes

Returns:

a DownloadManager.Request to handle the request

save

public RequestToken save(int flags,
                         BaasHandler<BaasUser> handler)

Asynchronously saves the updates made to the current user.

Parameters:

flags - RequestOptions

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to handle the async request

saveSync

public BaasResult<BaasUser> saveSync()

Synchronously saves the updates made to the current user.

Returns:

the result of the request

setPassword

public BaasUser setPassword(java.lang.String password)

Sets the password for this user. This should be called prior of any signup/login request, with a non null argument. Calling this with a null argument has the effect of erasing the password.

Parameters:

password - the password

Returns:

this user with the password set.

signup

public RequestToken signup(BaasHandler<BaasUser> handler)

Asynchronously signups this user to baasbox using provided password and default RequestOptions

Parameters:

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to manage the asynchronous request

signup

public RequestToken signup(int flags,
                           BaasHandler<BaasUser> handler)

Asynchronously signups this user to baasbox using provided password and priority

Parameters:

flags - RequestOptions

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to manage the asynchronous request

signupSync

public BaasResult<BaasUser> signupSync()

Synchronously signups this user to BaasBox.

Returns:

the result of the request

unfollow

public RequestToken unfollow(BaasHandler<BaasUser> user)

unfollow

public RequestToken unfollow(int flags,
                             BaasHandler<BaasUser> handler)

Asynchronously requests to unfollow the user

Parameters:

flags - RequestOptions

handler - an handler to be invoked when the request completes

Returns:

a RequestToken to manage the request

unfollowSync

public BaasResult<BaasUser> unfollowSync()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object