io.realm

Class SyncSession

java.lang.Object

io.realm.SyncSession

public class SyncSession
extends Object

This class represents the connection to the Realm Object Server for one SyncConfiguration.

A Session is created by opening a Realm instance using that configuration. Once a session has been created, it will continue to exist until the app is closed or all threads using this SyncConfiguration closes their respective Realms.

A session is fully controlled by Realm, but can provide additional information in case of errors. It is passed along in all SyncSession.ErrorHandlers.

This object is thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SyncSession.ErrorHandler Interface used to report any session errors.

Method Summary

Modifier and Type	Method and Description
void	downloadAllServerChanges() Calling this method will block until all known remote changes have been downloaded and applied to the Realm.
SyncConfiguration	getConfiguration() Returns the SyncConfiguration that is responsible for controlling the session.
URI	getServerUrl() Returns the URI describing the remote Realm which this session connects to and synchronizes changes with.
SyncUser	getUser() Returns the SyncUser defined by the SyncConfiguration that is used to connect to the Realm Object Server.

Methods inherited from class java.lang.Object

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

Method Detail

getConfiguration

public SyncConfiguration getConfiguration()

Returns the SyncConfiguration that is responsible for controlling the session.

Returns:

SyncConfiguration that defines and controls this session.

getUser

public SyncUser getUser()

Returns the SyncUser defined by the SyncConfiguration that is used to connect to the Realm Object Server.

Returns:

SyncUser used to authenticate the session on the Realm Object Server.

getServerUrl

public URI getServerUrl()

Returns the URI describing the remote Realm which this session connects to and synchronizes changes with.

Returns:

URI describing the remote Realm.

downloadAllServerChanges

public void downloadAllServerChanges()
                              throws InterruptedException

Calling this method will block until all known remote changes have been downloaded and applied to the Realm. This will involve network access, so calling this method should only be done from a non-UI thread.

If the device is offline, this method might never return.

This method cannot be called before the session has been started.

Throws:

IllegalStateException - if called on the Android main thread.

InterruptedException - if the thread was interrupted while downloading was in progress.