io.realm

Class SyncSession

java.lang.Object

io.realm.SyncSession

public final class SyncSession
extends Object

See Also:

SessionState

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 the connection to the Realm Object Server for one SyncConfiguration.

A Session is created by either calling SyncManager.getSession(SyncConfiguration) or 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 the SyncConfiguration is no longer used.

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
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.
SessionState	getState() Returns the state of this session.
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.

getState

public SessionState getState()

Returns the state of this session.

Returns:

the current SessionState for this session.