io.realm

Class SyncConfiguration

java.lang.Object

io.realm.RealmConfiguration

io.realm.SyncConfiguration

public class SyncConfiguration
extends RealmConfiguration

An SyncConfiguration is used to setup a Realm that can be synchronized between devices using the Realm Object Server.

A valid SyncUser is required to create a SyncConfiguration. See SyncCredentials and SyncUser.loginAsync(SyncCredentials, String, SyncUser.Callback) for more information on how to get a user object.

A minimal SyncConfiguration can be found below.

 
 SyncConfiguration config = new SyncConfiguration.Builder(context)
   .serverUrl("realm://objectserver.realm.io/~/default")
   .user(myUser)
   .build();
 
 

Synchronized Realms only support additive migrations which can be detected and performed automatically, so the following builder options are not accessible compared to a normal Realm:

• deleteRealmIfMigrationNeeded()
• migration(Migration)

Synchronized Realms are created by using Realm.getInstance(RealmConfiguration) and Realm.getDefaultInstance() like ordinary unsynchronized Realms.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncConfiguration.Builder Builder used to construct instances of a SyncConfiguration in a fluent manner.

Field Summary

Fields inherited from class io.realm.RealmConfiguration

DEFAULT_REALM_NAME, KEY_LENGTH

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
SyncSession.ErrorHandler	getErrorHandler()
URI	getServerUrl() Returns the fully disambiguated URI for the remote Realm i.e., the /~/ placeholder has been replaced by the proper user ID.
SyncUser	getUser() Returns the user.
int	hashCode()
boolean	shouldDeleteRealmOnLogout() Returns true if the Realm file must be deleted once the SyncUser owning it logs out.
boolean	shouldWaitForInitialRemoteData() Returns true if the Realm will download all known changes from the remote server before being opened the first time.
String	toString()

Methods inherited from class io.realm.RealmConfiguration

getDurability, getEncryptionKey, getMigration, getPath, getRealmDirectory, getRealmFileName, getRealmObjectClasses, getRxFactory, getSchemaVersion, isReadOnly, shouldDeleteRealmIfMigrationNeeded

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class RealmConfiguration

hashCode

public int hashCode()

Overrides:

hashCode in class RealmConfiguration

toString

public String toString()

Overrides:

toString in class RealmConfiguration

getUser

public SyncUser getUser()

Returns the user.

Returns:

the user.

getServerUrl

public URI getServerUrl()

Returns the fully disambiguated URI for the remote Realm i.e., the /~/ placeholder has been replaced by the proper user ID.

Returns:

URI identifying the remote Realm this local Realm is synchronized with.

getErrorHandler

public SyncSession.ErrorHandler getErrorHandler()

shouldDeleteRealmOnLogout

public boolean shouldDeleteRealmOnLogout()

Returns true if the Realm file must be deleted once the SyncUser owning it logs out.

Returns:

true if the Realm file must be deleted if the SyncUser logs out. false if the file is allowed to remain behind.

shouldWaitForInitialRemoteData

public boolean shouldWaitForInitialRemoteData()

Returns true if the Realm will download all known changes from the remote server before being opened the first time.

Returns:

true if all remote changes will be downloaded before the Realm can be opened. false if the Realm can be opened immediately.