Realm Kotlin SDK - Sync/io.realm.kotlin.mongodb.sync/SyncSession/State

State

The possible states for SyncSession to be.

A Realm will automatically synchronize data with the server if the session is either ACTIVE or DYING and is connected.

Entries

WAITING_FOR_ACCESS_TOKEN

The user is attempting to synchronize data but needs a valid access token to do so. Realm will either use a cached token or automatically try to acquire one based on the current users login. This requires a network connection.

DYING

DYING()

The Realm was closed, but still contains data that needs to be synchronized to the server. The session will attempt to upload all local data before going INACTIVE.

PAUSED

PAUSED()

The Realm is open and has a connection to the server, but no data is allowed to be transferred between the device and the server. Call SyncSession.resume to start transferring data again. The state will then become ACTIVE.

ACTIVE

ACTIVE()

The Realm is open and data will be synchronized between the device and the server if the underlying connection is connected.

INACTIVE

INACTIVE()

This is the initial state. The session is closed. No data is being synchronized. The session will automatically transition to ACTIVE when a Realm is opened.

Properties

name

val name: String

ordinal

val ordinal: Int