com.eyro.mesosfer

Class MesosferUser

java.lang.Object

com.eyro.mesosfer.MesosferUser

public final class MesosferUser
extends java.lang.Object

The MesosferUser is a local representation of user data that can be saved and retrieved from the Mesosfer cloud.

Author:

Eyro Labs

Method Summary

Modifier and Type	Method and Description
void	changePasswordAsync(java.lang.String oldPassword, java.lang.String newPassword, ChangePasswordCallback callback) Change password user using background thread.
static MesosferUser	createUser() Constructs a new MesosferUser with no data in it.
void	fetchAsync(GetCallback<MesosferUser> callback) Fetches this user with the data from the server in a background thread.
java.lang.String	getCountry() Gets country code.
java.util.Date	getCreatedAt() This reports time as the server sees it, so that if you create a MesosferUser, then wait a while, and then call saveAsync(SaveCallback), the creation time will be the time of the first saveAsync(SaveCallback) call rather than the time the object was created locally.
static MesosferUser	getCurrentUser() This retrieves the currently logged in MesosferUser with a valid session, either from memory or disk if necessary.
MesosferObject	getData() Gets the MesosferObject that already saved in MesosferUser.
org.json.JSONArray	getDataArray(java.lang.String key) Gets the JSONArray value from the getData() given key string.
boolean	getDataBoolean(java.lang.String key) Gets the Boolean value from the getData() given key string.
java.util.Date	getDataDate(java.lang.String key) Gets the Date value from the getData() given key string.
double	getDataDouble(java.lang.String key) Gets the Double value from the getData() given key string.
int	getDataInteger(java.lang.String key) Gets the Integer value from the getData() given key string.
long	getDataLong(java.lang.String key) Gets the Long value from the getData() given key string.
java.lang.Number	getDataNumber(java.lang.String key) Gets the Number value from the getData() given key string.
org.json.JSONObject	getDataObject(java.lang.String key) Gets the JSONObject value from the getData() given key string.
MesosferDataSchema	getDataSchema() Gets data MesosferDataSchema of this object.
java.lang.String	getDataString(java.lang.String key) Gets the String value from the getData() given key string.
java.lang.String	getEmail() Retrieves the email address.
java.lang.String	getFirstName() Gets first name.
java.lang.String	getLastName() Gets last name.
java.lang.String	getObjectId() Accessor to the object id.
java.lang.String	getPhone() Gets phone.
static MesosferQuery<MesosferUser>	getQuery() Constructs a query for MesosferUser.
java.util.Date	getUpdatedAt() This reports time as the server sees it, so that if you make changes to a MesosferUser, then wait a while, and then call saveAsync(SaveCallback), the updated time will be the time of the saveAsync(SaveCallback) call rather than the time the object was changed locally.
static void	logInAsync(java.lang.String email, java.lang.String password, LogInCallback callback) Logs in a user with an email and password.
static void	logOutAsync(LogOutCallback callback) Logs out the currently logged in user session.
void	registerAsync(RegisterCallback callback) Signs up a new user.
void	saveAsync(SaveCallback callback) Saves this object to the server in a background thread.
MesosferUser	setCountry(java.lang.String country) Sets country code.
MesosferUser	setData(java.lang.String key, java.lang.Object value) Add a key-value pair to this object.
MesosferUser	setEmail(java.lang.String email) Sets the email address.
MesosferUser	setFirstName(java.lang.String firstName) Sets first name.
MesosferUser	setLastName(java.lang.String lastName) Sets last name.
MesosferUser	setPassword(java.lang.String password) Sets the password.
MesosferUser	setPhone(java.lang.String phone) Sets phone.
org.json.JSONObject	toJSON() To put all keys and values of this MesosferData into a JSONObject.
java.lang.String	toString()
void	updateDataAsync(SaveCallback callback) Deprecated. Use saveAsync(SaveCallback) instead

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

createUser

public static MesosferUser createUser()

Constructs a new MesosferUser with no data in it. A MesosferUser constructed in this way will not have an objectId and will not persist to the database until registerAsync(RegisterCallback) is called.

Returns:

A new instance of MesosferUser

getQuery

public static MesosferQuery<MesosferUser> getQuery()

Constructs a query for MesosferUser.

Returns:

A new instance of MesosferQuery

getCurrentUser

public static MesosferUser getCurrentUser()

This retrieves the currently logged in MesosferUser with a valid session, either from memory or disk if necessary.

Returns:

The currently logged in MesosferUser

getEmail

public java.lang.String getEmail()

Retrieves the email address.

getObjectId

public java.lang.String getObjectId()

Accessor to the object id. An object id is assigned as soon as an object is saved to the server. The combination of a bucketName and an objectId uniquely identifies an object in your application.

Returns:

The object id.

getCreatedAt

public java.util.Date getCreatedAt()

This reports time as the server sees it, so that if you create a MesosferUser, then wait a while, and then call saveAsync(SaveCallback), the creation time will be the time of the first saveAsync(SaveCallback) call rather than the time the object was created locally.

Returns:

The first time this object was saved on the server.

getUpdatedAt

public java.util.Date getUpdatedAt()

This reports time as the server sees it, so that if you make changes to a MesosferUser, then wait a while, and then call saveAsync(SaveCallback), the updated time will be the time of the saveAsync(SaveCallback) call rather than the time the object was changed locally.

Returns:

The last time this object was updated on the server.

getDataSchema

public MesosferDataSchema getDataSchema()

Gets data MesosferDataSchema of this object.

Returns:

The MesosferDataSchema object

getData

public MesosferObject getData()

Gets the MesosferObject that already saved in MesosferUser.

Returns:

The MesosferObject

getDataString

public java.lang.String getDataString(java.lang.String key)

Gets the String value from the getData() given key string.

Parameters:

key - the key of String value to get from

Returns:

the String value

getDataDate

public java.util.Date getDataDate(java.lang.String key)

Gets the Date value from the getData() given key string.

Parameters:

key - the key of Date value to get from

Returns:

the Date value

getDataInteger

public int getDataInteger(java.lang.String key)

Gets the Integer value from the getData() given key string.

Parameters:

key - the key of Integer value to get from

Returns:

the Integer value

getDataDouble

public double getDataDouble(java.lang.String key)

Gets the Double value from the getData() given key string.

Parameters:

key - the key of Double value to get from

Returns:

the Double value

getDataLong

public long getDataLong(java.lang.String key)

Gets the Long value from the getData() given key string.

Parameters:

key - the key of Long value to get from

Returns:

the Long value

getDataNumber

public java.lang.Number getDataNumber(java.lang.String key)

Gets the Number value from the getData() given key string.

Parameters:

key - the key of Number value to get from

Returns:

the Number value

getDataBoolean

public boolean getDataBoolean(java.lang.String key)

Gets the Boolean value from the getData() given key string.

Parameters:

key - the key of Boolean value to get from

Returns:

the Boolean value

getDataObject

public org.json.JSONObject getDataObject(java.lang.String key)

Gets the JSONObject value from the getData() given key string.

Parameters:

key - the key of JSONObject value to get from

Returns:

the JSONObject value

getDataArray

public org.json.JSONArray getDataArray(java.lang.String key)

Gets the JSONArray value from the getData() given key string.

Parameters:

key - the key of JSONArray value to get from

Returns:

the JSONArray value

getFirstName

public java.lang.String getFirstName()

Gets first name.

Returns:

the first name

getLastName

public java.lang.String getLastName()

Gets last name.

Returns:

the last name

getCountry

@Nullable
public java.lang.String getCountry()

Gets country code.

Returns:

the country code

getPhone

@Nullable
public java.lang.String getPhone()

Gets phone.

Returns:

the phone

toJSON

public org.json.JSONObject toJSON()

To put all keys and values of this MesosferData into a JSONObject.

Returns:

The JSONObject of all keys and values

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setEmail

public MesosferUser setEmail(java.lang.String email)

Sets the email address.

Parameters:

email - The email address to set.

Returns:

The current instance for chaining

setPassword

public MesosferUser setPassword(java.lang.String password)

Sets the password.

Parameters:

password - The password to set.

Returns:

The current instance for chaining

setFirstName

public MesosferUser setFirstName(java.lang.String firstName)

Sets first name.

Parameters:

firstName - The first name to set.

Returns:

The current instance for chaining

setLastName

public MesosferUser setLastName(java.lang.String lastName)

Sets last name.

Parameters:

lastName - The last name to set.

Returns:

The current instance for chaining

setCountry

public MesosferUser setCountry(@NonNull
                               java.lang.String country)

Sets country code.

Parameters:

country - The country to set.

Returns:

The current instance for chaining

setPhone

public MesosferUser setPhone(@NonNull
                             java.lang.String phone)

Sets phone.

Parameters:

phone - the phone to set.

Returns:

The current instance for chaining

setData

public MesosferUser setData(@NonNull
                            java.lang.String key,
                            java.lang.Object value)

Add a key-value pair to this object. It is recommended to name keys in camelCaseLikeThis.

Parameters:

key - Keys must be alphanumerical, and start with a letter.

value - Values may be numerical, String, JSONObject, JSONArray, JSONObject.NULL, or Dates. value may not be null.

Returns:

This current instance for chaining mode

registerAsync

public void registerAsync(RegisterCallback callback)

Signs up a new user. You should call this instead of saveAsync(SaveCallback) for new MesosferUsers. This will create a new MesosferUser on the server, and also persist the session on disk so that you can access the user using getCurrentUser().

An email and a password must be set before calling register.

This is preferable to using registerAsync(RegisterCallback)

Parameters:

callback - callback.done(user, e) is called when the register completes.

logInAsync

public static void logInAsync(@NonNull
                              java.lang.String email,
                              @NonNull
                              java.lang.String password,
                              LogInCallback callback)

Logs in a user with an email and password. On success, this saves the session to disk, so you can retrieve the currently logged in user using getCurrentUser().

This is preferable to using logInAsync(String, String, LogInCallback), unless your code is already running from a background thread.

Parameters:

email - The email address to log in with.

password - The password to log in with.

callback - callback.done(user, e) is called when the login completes.

fetchAsync

public void fetchAsync(GetCallback<MesosferUser> callback)

Fetches this user with the data from the server in a background thread.

Parameters:

callback - callback.done(object, e) is called when the fetch completes.

logOutAsync

public static void logOutAsync(LogOutCallback callback)

Logs out the currently logged in user session. This will remove the session from disk, log out of linked services, and future calls to getCurrentUser() will return null.

updateDataAsync

@Deprecated
public void updateDataAsync(SaveCallback callback)

Deprecated. Use saveAsync(SaveCallback) instead

Parameters:

callback - callback.done(e) is called when the save completes.

saveAsync

public void saveAsync(SaveCallback callback)

Saves this object to the server in a background thread.

Parameters:

callback - callback.done(e) is called when the save completes.

changePasswordAsync

public void changePasswordAsync(java.lang.String oldPassword,
                                java.lang.String newPassword,
                                ChangePasswordCallback callback)

Change password user using background thread.

Parameters:

oldPassword - the old password to change

newPassword - the new password to set

callback - callback.done(e) is called when the save completes.