SyncUser (Realm 3.2.1)

java.lang.Object
- io.realm.SyncUser

```
public class SyncUser
extends Object
```
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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SyncUser.Callback`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Map<String,SyncUser>`	`all()` Returns all valid users known by this device.
`void`	`changePassword(String newPassword)` Changes this user's password.
`RealmAsyncTask`	`changePasswordAsync(String newPassword, SyncUser.Callback callback)` Changes this user's password asynchronously.
`static SyncUser`	`currentUser()` Returns the current user that is logged in and still valid.
`boolean`	`equals(Object o)`
`static SyncUser`	`fromJson(String user)` Loads a user that has previously been serialized using `toJson()`.
`Token`	`getAccessToken()` Returns this user's access token.
`URL`	`getAuthenticationUrl()` Returns the `URL` where this user was authenticated.
`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`	`isAdmin()` Returns `true` if this user is an administrator on the Realm Object Server, `false` otherwise.
`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.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - currentUser
```
public static SyncUser currentUser()
```
    Returns the current user that is logged in and still valid. A user is invalidated when he/she logs out or the user's access token expires.
    
    Returns:
    
    current SyncUser that has logged in and is still valid. null if no user is logged in or the user has expired.
    
    Throws:
    
    IllegalStateException - if multiple users are logged in.
  - all
```
public static Map<String,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 map from user identifier to user. It includes 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.
    
    Returns:
    
    representation of the async task that can be used to cancel it if needed.
    
    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.
  - changePassword
```
public void changePassword(String newPassword)
                    throws ObjectServerError
```
    Changes this user's password. This is done synchronously and involves the network, so calling this method on the Android UI thread will always crash.
    WARNING: Changing a users password using an authentication server that doesn't use HTTPS is a major security flaw, and should only be done while testing.
    
    Parameters:
    
    newPassword - the user's new password.
    
    Throws:
    
    ObjectServerError - if the password could not be changed.
  - changePasswordAsync
```
public RealmAsyncTask changePasswordAsync(String newPassword,
                                          SyncUser.Callback callback)
```
    Changes this user's password asynchronously.
    WARNING: Changing a users password using an authentication server that doesn't use HTTPS is a major security flaw, and should only be done while testing.
    
    Parameters:
    
    newPassword - the user's new password.
    
    callback - callback when login has completed or failed. The callback will always happen on the same thread as this method is called on.
    
    Returns:
    
    representation of the async task that can be used to cancel it if needed.
    
    Throws:
    
    IllegalArgumentException - if not on a Looper thread.
  - 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 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.
  - isAdmin
```
public boolean isAdmin()
```
    Returns true if this user is an administrator on the Realm Object Server, false otherwise.
    Administrators can access all Realms on the server as well as change the permissions of the Realms.
    
    Returns:
    
    true if the user is an administrator on 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 Token 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
  - getAuthenticationUrl
```
public URL getAuthenticationUrl()
```
    Returns the URL where this user was authenticated.
    
    Returns:
    
    URL where the user was authenticated.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SyncUser

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

currentUser

all

fromJson

login

loginAsync

logout

changePassword

changePasswordAsync

toJson

isValid

isAdmin

getIdentity

getAccessToken

getManagementRealm

getAuthenticationUrl

equals

hashCode

toString