io.divide.client

Class BackendUser

java.lang.Object

io.divide.shared.transitory.TransientObject

io.divide.shared.transitory.Credentials

io.divide.client.BackendUser

All Implemented Interfaces:

java.io.Serializable

public final class BackendUser
extends Credentials

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.divide.shared.transitory.TransientObject

TransientObject.MetaKey

Field Summary

Fields inherited from class io.divide.shared.transitory.Credentials

AUTH_TOKEN_KEY, EMAIL_KEY, PUSH_MESSAGING_KEY, RECOVERY_TOKEN_KEY, USER_GROUP_KEY, USERNAME_KEY, VALIDATION_KEY

Fields inherited from class io.divide.shared.transitory.TransientObject

CREATE_DATE_KEY, meta_data, META_DATA, MODIFIED_DATE_KEY, OBJECT_KEY, OBJECT_TYPE_KEY, OWNER_ID_KEY, user_data, USER_DATA

Constructor Summary

Constructors

Constructor and Description
BackendUser()
BackendUser(java.lang.String username, java.lang.String email, java.lang.String password)

Method Summary

Methods

Modifier and Type	Method and Description
static BackendUser	from(ValidCredentials credentials) Convience method to initialize BackendUser from ValidCredentials
static BackendUser	fromToken(java.lang.String token) Login using an authtoken
static LocalCredentials	getStoredAccount() Used to access the stored credentials.
static BackendUser	getUser()
protected boolean	isSystemUser()
static rx.Observable<BackendUser>	logInInBackground(java.lang.String email, java.lang.String password) Perform asyncronously login attempt.
static void	logout()
void	requestPasswordReset(java.lang.String email)
rx.Observable<java.lang.Boolean>	requestPasswordResetInBackground(java.lang.String email)
void	save() Asynchronously saves this user object.
rx.Observable<java.lang.Void>	saveASync() Asynchronously saves this user object return an Observable to monitor.
static SignInResponse	signIn(LoginCredentials loginCredentials) Perform syncronously login attempt.
static SignInResponse	signIn(java.lang.String email, java.lang.String password) Perform syncronously login attempt.
boolean	signUp() Synchronously sign up using credentials provided via constructor or setters.
static SignUpResponse	signUp(SignUpCredentials signUpCredentials) Perform syncronously sign up attempt.
static SignUpResponse	signUp(java.lang.String username, java.lang.String email, java.lang.String password) Perform syncronously sign up attempt.
static rx.Observable<BackendUser>	signUpInBackground(java.lang.String username, java.lang.String email, java.lang.String password) Perform asyncronously sign up attempt.
java.lang.String	toString()

Methods inherited from class io.divide.shared.transitory.Credentials

decryptPassword, encryptPassword, getAuthToken, getEmailAddress, getPassword, getPushMessagingKey, getRecoveryToken, getSafe, getUserGroup, getUsername, getValidation, setAuthToken, setEmailAddress, setPassword, setPushMessagingKey, setRecoveryToken, setUserGroup, setUsername, setValidation

Methods inherited from class io.divide.shared.transitory.TransientObject

equals, get, get, getCreateDate, getFilePermissions, getLoggedInUser, getMetaData, getModifiedDate, getObjectKey, getObjectType, getOwnerId, getUserData, hashCode, isReadable, isWritable, meta_get, meta_put, meta_remove, put, put, putAll, remove, removeAll, setFilePermissions, setOwnerId

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendUser

public BackendUser()

BackendUser

public BackendUser(java.lang.String username,
           java.lang.String email,
           java.lang.String password)

Method Detail

from

public static BackendUser from(ValidCredentials credentials)

Convience method to initialize BackendUser from ValidCredentials

Parameters:

credentials -

Returns:

getUser

public static BackendUser getUser()

Returns:

Currently logged in user.

getStoredAccount

public static LocalCredentials getStoredAccount()

Used to access the stored credentials.

Returns:

Locally stored credentials for the logged in user.

isSystemUser

protected final boolean isSystemUser()

Overrides:

isSystemUser in class Credentials

fromToken

public static BackendUser fromToken(java.lang.String token)

Login using an authtoken

Parameters:

token -

Returns:

BackendUser for the sent token.

signIn

public static SignInResponse signIn(LoginCredentials loginCredentials)

Perform syncronously login attempt.

Parameters:

loginCredentials - credentials used for login attempt.

Returns:

login results.

signIn

public static SignInResponse signIn(java.lang.String email,
                    java.lang.String password)

Perform syncronously login attempt.

Parameters:

email - user email address

password - user password

Returns:

login results.

signUp

public static SignUpResponse signUp(SignUpCredentials signUpCredentials)

Perform syncronously sign up attempt.

Parameters:

signUpCredentials - credentials used for sign up attempt.

Returns:

signup results.

signUp

public static SignUpResponse signUp(java.lang.String username,
                    java.lang.String email,
                    java.lang.String password)

Perform syncronously sign up attempt.

Parameters:

username - user name user will be identified by.

email - user email address

password - user password

Returns:

login results.

logInInBackground

public static rx.Observable<BackendUser> logInInBackground(java.lang.String email,
                                           java.lang.String password)

Perform asyncronously login attempt.

Parameters:

email - user email address

password - user password

Returns:

login results as observable.

signUpInBackground

public static rx.Observable<BackendUser> signUpInBackground(java.lang.String username,
                                            java.lang.String email,
                                            java.lang.String password)

Perform asyncronously sign up attempt.

Parameters:

username - user name user will be identified by.

email - user email address

password - user password

Returns:

login results as observable.

logout

public static void logout()

requestPasswordReset

public void requestPasswordReset(java.lang.String email)

requestPasswordResetInBackground

public rx.Observable<java.lang.Boolean> requestPasswordResetInBackground(java.lang.String email)

signUp

public boolean signUp()

Synchronously sign up using credentials provided via constructor or setters.

Returns:

boolean indicating sign up success

save

public void save()

Asynchronously saves this user object. Saving any data added via the put() method. put("1"); put(1); etc.

saveASync

public rx.Observable<java.lang.Void> saveASync()

Asynchronously saves this user object return an Observable to monitor. Saving any data added via the put() method. put("1"); put(1); etc.

Returns:

Obserable to monitor operation.

toString

public java.lang.String toString()

Overrides:

toString in class TransientObject