io.realm.mongodb.sync

Class Sync

java.lang.Object

io.realm.mongodb.sync.Sync

public abstract class Sync
extends Object

A sync manager handling synchronization of local Realms with remote Realm Apps.

The primary role of this is to access the SyncSession for a synchronized Realm. After opening the synchronized Realm you can access the SyncSession and perform synchronization related operations as shown below:

     App app = new App("app-id");
     User user = app.login(Credentials.anonymous());
     SyncConfiguration syncConfiguration = new SyncConfiguration.Builder(user, "<partition value>")
              .build();
     Realm instance = Realm.getInstance(syncConfiguration);
     SyncSession session = app.getSync().getSession(syncConfiguration);

     instance.executeTransaction(realm -> {
         realm.insert(...);
     });
     session.uploadAllLocalChanges();
     instance.close();
 

See Also:

App.getSync(), getSession(SyncConfiguration)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Sync.Debug Debugging related options.

Method Summary

Modifier and Type	Method and Description
Collection<SyncSession>	getAllSessions() Gets a collection of all the cached SyncSession.
SyncSession	getOrCreateSession(SyncConfiguration syncConfiguration) Gets any cached SyncSession for the given SyncConfiguration or create a new one if no one exists.
SyncSession	getSession(SyncConfiguration syncConfiguration) Gets a cached SyncSession for the given SyncConfiguration or throw if no one exists yet.
void	reconnect() Realm will automatically detect when a device gets connectivity after being offline and resume syncing.

Methods inherited from class java.lang.Object

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

Method Detail

getSession

public SyncSession getSession(SyncConfiguration syncConfiguration)
                       throws IllegalStateException

Gets a cached SyncSession for the given SyncConfiguration or throw if no one exists yet. A session should exist after you open a Realm with a SyncConfiguration.

Parameters:

syncConfiguration - configuration object for the synchronized Realm.

Returns:

the SyncSession for the specified Realm.

Throws:

IllegalArgumentException - if syncConfiguration is null.

IllegalStateException - if the session could not be found using the provided SyncConfiguration.

getAllSessions

public Collection<SyncSession> getAllSessions()

Gets a collection of all the cached SyncSession.

Returns:

a collection of SyncSession.

getOrCreateSession

public SyncSession getOrCreateSession(SyncConfiguration syncConfiguration)

Gets any cached SyncSession for the given SyncConfiguration or create a new one if no one exists. Note: This is mainly for internal usage, consider using getSession(SyncConfiguration) instead.

Parameters:

syncConfiguration - configuration object for the synchronized Realm.

Returns:

the SyncSession for the specified Realm.

Throws:

IllegalArgumentException - if syncConfiguration is null.

reconnect

public void reconnect()

Realm will automatically detect when a device gets connectivity after being offline and resume syncing.

However, as some of these checks are performed using incremental backoff, this will in some cases not happen immediately.

In those cases it can be beneficial to call this method manually, which will force all sessions to attempt to reconnect immediately and reset any timers they are using for incremental backoff.