io.realm

Class SyncUser

java.lang.Object

io.realm.SyncUser

public class SyncUser
extends Object

This software is considered in beta phase. It indicates that any public interface can change without prior announcements. Moreover, classes, constructors, and methods annotated as beta are not considered at production quality, and should be used with care.

This class represents a user on the Realm Object Server. The credentials are provided by various 3rd party providers (Facebook, Google, etc.).

A user can log in to the Realm Object Server, and if access is granted, it is possible to synchronize the local and the remote Realm. Moreover, synchronization is halted when the user is logged out.

It is possible to persist a user. By retrieving a user, there is no need to log in to the 3rd party provider again. Persisting a user between sessions, the user's credentials are stored locally on the device, and should be treated as sensitive data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SyncUser.Callback

Method Summary

Modifier and Type	Method and Description
static Collection<SyncUser>	all() Returns all valid users known by this device.
static SyncUser	currentUser() Returns the last user that has logged in and who is still valid.
boolean	equals(Object o)
static SyncUser	fromJson(String user) Loads a user that has previously been serialized using toJson().
String	getAccessToken() Returns this user's access token.
String	getIdentity() Returns the identity of this user on the Realm Object Server.
Realm	getManagementRealm() Returns an instance of the Management Realm owned by the user.
int	hashCode()
boolean	isValid() Returns true if the user is logged into the Realm Object Server.
static SyncUser	login(SyncCredentials credentials, String authenticationUrl) Logs in the user to the Realm Object Server.
static RealmAsyncTask	loginAsync(SyncCredentials credentials, String authenticationUrl, SyncUser.Callback callback) Logs in the user to the Realm Object Server.
void	logout() Logs out the user from the Realm Object Server.
String	toJson() Returns a JSON token representing this user.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

currentUser

public static SyncUser currentUser()

Returns the last user that has logged in and who is still valid. A user is invalidated when he/she logs out or the user's access token expire.

Returns:

last SyncUser that has logged in and who is still valid. null if no current user or user has been invalidated.

all

public static Collection<SyncUser> all()

Returns all valid users known by this device. A user is invalidated when he/she logs out or the user's access token expires.

Returns:

a list of all known valid users.

fromJson

public static SyncUser fromJson(String user)

Loads a user that has previously been serialized using toJson().

Parameters:

user - JSON string representing the user.

Returns:

the user object.

Throws:

IllegalArgumentException - if the JSON couldn't be converted to a valid SyncUser object.

login

public static SyncUser login(SyncCredentials credentials,
                             String authenticationUrl)
                      throws ObjectServerError

Logs in the user to the Realm Object Server. This is done synchronously, so calling this method on the Android UI thread will always crash. A logged in user is required to be able to create a SyncConfiguration.

Parameters:

credentials - credentials to use.

authenticationUrl - server that can authenticate against.

Throws:

ObjectServerError - if the login failed.

IllegalArgumentException - if the URL is malformed.

loginAsync

public static RealmAsyncTask loginAsync(SyncCredentials credentials,
                                        String authenticationUrl,
                                        SyncUser.Callback callback)

Logs in the user to the Realm Object Server. A logged in user is required to be able to create a SyncConfiguration.

Parameters:

credentials - credentials to use.

authenticationUrl - server that the user is authenticated against.

callback - callback when login has completed or failed. The callback will always happen on the same thread as this this method is called on.

Throws:

IllegalArgumentException - if not on a Looper thread.

logout

public void logout()

Logs out the user from the Realm Object Server. Once the Object Server has confirmed the logout any registered AuthenticationListener will be notified and user credentials will be deleted from this device.

Throws:

IllegalStateException - if any Realms owned by this user is still open. They should be closed before logging out.

toJson

public String toJson()

Returns a JSON token representing this user.

Possession of this JSON token can potentially grant access to data stored on the Realm Object Server, so it should be treated as sensitive data.

Returns:

JSON string representing this user. It can be converted back into a real user object using fromJson(String).

See Also:

fromJson(String)

isValid

public boolean isValid()

Returns true if the user is logged into the Realm Object Server. If this method returns true it implies that the user has valid credentials that have not expired.

The user might still be have been logged out by the Realm Object Server which will not be detected before the user tries to actively synchronize a Realm. If a logged out user tries to synchronize a Realm, an error will be reported to the SyncSession.ErrorHandler defined by SyncConfiguration.Builder.errorHandler(SyncSession.ErrorHandler).

Returns:

true if the User is logged into the Realm Object Server, false otherwise.

getIdentity

public String getIdentity()

Returns the identity of this user on the Realm Object Server. The identity is a guaranteed to be unique among all users on the Realm Object Server.

Returns:

identity of the user on the Realm Object Server. If the user has logged out or the login has expired null is returned.

getAccessToken

public String getAccessToken()

Returns this user's access token. This is the users credential for accessing the Realm Object Server and should be treated as sensitive data.

Returns:

the user's access token. If this user has logged out or the login has expired null is returned.

getManagementRealm

public Realm getManagementRealm()

Returns an instance of the Management Realm owned by the user.

This Realm can be used to control access and permissions for Realms owned by the user. This includes giving other users access to Realms.

See Also:

How to control permissions

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object