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.
static class	SyncSession.State

Method Summary

Modifier and Type	Method and Description
void	addDownloadProgressListener(ProgressMode mode, ProgressListener listener) Adds a progress listener tracking changes that need to be downloaded from the Realm Object Server.
void	addUploadProgressListener(ProgressMode mode, ProgressListener listener) Adds a progress listener tracking changes that need to be uploaded from the device to the Realm Object Server.
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.
SyncSession.State	getState() Get the current session's state, as defined in SyncSession.State.
SyncUser	getUser() Returns the SyncUser defined by the SyncConfiguration that is used to connect to the Realm Object Server.
void	removeProgressListener(ProgressListener listener) Removes a progress listener.
void	uploadAllLocalChanges() Calling this method will block until all known local changes have been uploaded to the 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.

getState

public SyncSession.State getState()

Get the current session's state, as defined in SyncSession.State. Note that the state may change after this method returns, example: the authentication token will expire, causing the session to move to SyncSession.State.WAITING_FOR_ACCESS_TOKEN after it was in SyncSession.State.ACTIVE.

Returns:

the state of the session.

See Also:

SyncSession.State

addDownloadProgressListener

public void addDownloadProgressListener(ProgressMode mode,
                                        ProgressListener listener)

Adds a progress listener tracking changes that need to be downloaded from the Realm Object Server.

The ProgressListener will be triggered immediately when registered, and periodically afterwards.

Parameters:

mode - type of mode used. See ProgressMode for more information.

listener - the listener to register.

addUploadProgressListener

public void addUploadProgressListener(ProgressMode mode,
                                      ProgressListener listener)

Adds a progress listener tracking changes that need to be uploaded from the device to the Realm Object Server.

The ProgressListener will be triggered immediately when registered, and periodically afterwards.

Parameters:

mode - type of mode used. See ProgressMode for more information.

listener - the listener to register.

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Removes a progress listener. If the listener wasn't registered, this method will do nothing.

Parameters:

listener - listener to remove.

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.

uploadAllLocalChanges

public void uploadAllLocalChanges()
                           throws InterruptedException

Calling this method will block until all known local changes have been uploaded to the server. 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.