SyncConfiguration.Builder (Realm 6.0.1)

java.lang.Object
- io.realm.SyncConfiguration.Builder

Enclosing class:

SyncConfiguration
```
public static final class SyncConfiguration.Builder
extends Object
```
Builder used to construct instances of a SyncConfiguration in a fluent manner.

Constructor Summary

Constructors
Constructor and Description

Builder(SyncUser user, String uri)
Deprecated.
Use SyncUser.createConfiguration(String) instead.

Constructors
Constructor and Description
`Builder(SyncUser user, String uri)` Deprecated. Use `SyncUser.createConfiguration(String)` instead.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SyncConfiguration.Builder`	`addModule(Object module)` Adds a module to the already defined modules.
`SyncConfiguration`	`build()` Creates the RealmConfiguration based on the builder parameters.
`SyncConfiguration.Builder`	`clientResyncMode(ClientResyncMode mode)` Configure the behavior in case of a Client Resync.
`SyncConfiguration.Builder`	`compactOnLaunch()` Setting this will cause Realm to compact the Realm file if the Realm file has grown too large and a significant amount of space can be recovered.
`SyncConfiguration.Builder`	`compactOnLaunch(CompactOnLaunchCallback compactOnLaunch)` Sets this to determine if the Realm file should be compacted before returned to the user.
`SyncConfiguration.Builder`	`directory(File directory)` Sets the local root directory where synchronized Realm files can be saved.
`SyncConfiguration.Builder`	`disableSSLVerification()` This will disable TLS certificate verification for the remote Realm Object Server.
`SyncConfiguration.Builder`	`encryptionKey(byte[] key)` Sets the 64 bytes key used to encrypt and decrypt the Realm file.
`SyncConfiguration.Builder`	`errorHandler(SyncSession.ErrorHandler errorHandler)` Sets the error handler used by this configuration.
`SyncConfiguration.Builder`	`fullSynchronization()` Define this Realm as a fully synchronized Realm.
`SyncConfiguration.Builder`	`initialData(Realm.Transaction transaction)` Sets the initial data in `Realm`.
`SyncConfiguration.Builder`	`inMemory()` Setting this will create an in-memory Realm instead of saving it to disk.
`SyncConfiguration.Builder`	`modules(Iterable<Object> modules)` Replaces the existing module(s) with one or more `RealmModule`s.
`SyncConfiguration.Builder`	`modules(Object baseModule, Object... additionalModules)` Replaces the existing module(s) with one or more `RealmModule`s.
`SyncConfiguration.Builder`	`name(String filename)` Sets the local file name for the Realm.
`SyncConfiguration.Builder`	`partialRealm()` Deprecated. Use `SyncUser.createConfiguration(String)` instead.
`SyncConfiguration.Builder`	`readOnly()` Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException`.
`SyncConfiguration.Builder`	`rxFactory(RxObservableFactory factory)` Sets the `RxObservableFactory` used to create Rx Observables from Realm objects.
`SyncConfiguration.Builder`	`schemaVersion(long schemaVersion)` Sets the schema version of the Realm.
`SyncConfiguration.Builder`	`trustedRootCA(String filename)` Provides the trusted root certificate(s) authority (CA) in `PEM` format, that should be used to validate the TLS connections to the Realm Object Server.
`SyncConfiguration.Builder`	`urlPrefix(String urlPrefix)` The prefix that is prepended to the path in the HTTP request that initiates a sync connection to the Realm Object Server.
`SyncConfiguration.Builder`	`waitForInitialRemoteData()` Setting this will cause the Realm to download all known changes from the server the first time a Realm is opened.
`SyncConfiguration.Builder`	`waitForInitialRemoteData(long timeout, TimeUnit unit)` Setting this will cause the Realm to download all known changes from the server the first time a Realm is opened.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
@Deprecated
public Builder(SyncUser user,
                           String uri)
```
    Deprecated. Use SyncUser.createConfiguration(String) instead.
    
    Creates an instance of the Builder for the SyncConfiguration. This SyncConfiguration will be for a fully synchronized Realm.
    Opening a synchronized Realm requires a valid user and an unique URI that identifies that Realm. In URIs, /~/ can be used as a placeholder for a user ID in case the Realm should only be available to one user e.g., "realm://objectserver.realm.io/~/default".
    The URL cannot end with .realm, .realm.lock or .realm.management.
    The /~/ will automatically be replaced with the user ID when creating the SyncConfiguration.
    Moreover, the URI defines the local location on disk. The default location of a synchronized Realm file is /data/data/<packageName>/files/realm-object-server/<user-id>/<last-path-segment>, but this behavior can be overwritten using name(String) and directory(File).
    Many Android devices are using FAT32 file systems. FAT32 file systems have a limitation that file names cannot be longer than 255 characters. Moreover, the entire URI should not exceed 256 characters. If file name and underlying path are too long to handle for FAT32, a shorter unique name will be generated. See also @{link https://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx}.
    
    Parameters:
    
    user - the user for this Realm. An authenticated SyncUser is required to open any Realm managed by a Realm Object Server.
    
    uri - URI identifying the Realm. If only a path like /~/default is given, the configuration will assume the file is located on the same server returned by SyncUser.getAuthenticationUrl().
    
    See Also:
    
    SyncUser.isValid()
- Method Detail
  - name
```
public SyncConfiguration.Builder name(String filename)
```
    Sets the local file name for the Realm. This will override the default name defined by the Realm URL.
    
    Parameters:
    
    filename - name of the local file on disk.
    
    Throws:
    
    IllegalArgumentException - if file name is null or empty.
  - directory
```
public SyncConfiguration.Builder directory(File directory)
```
    Sets the local root directory where synchronized Realm files can be saved.
    Synchronized Realms will not be saved directly in the provided directory, but instead in a subfolder that matches the path defined by Realm URI. As Realm server URIs are unique this means that multiple users can save their Realms on disk without the risk of them overwriting each other files.
    The default location is context.getFilesDir().
    
    Parameters:
    
    directory - directory on disk where the Realm file can be saved.
    
    Throws:
    
    IllegalArgumentException - if the directory is not valid.
  - encryptionKey
```
public SyncConfiguration.Builder encryptionKey(byte[] key)
```
    Sets the 64 bytes key used to encrypt and decrypt the Realm file.
    
    Parameters:
    
    key - the encryption key.
    
    Throws:
    
    IllegalArgumentException - if key is invalid.
  - schemaVersion
```
public SyncConfiguration.Builder schemaVersion(long schemaVersion)
```
    Sets the schema version of the Realm.
    Synced Realms only support additive schema changes which can be applied without requiring a manual migration. The schema version will only be used as an indication to the underlying storage layer to remove or add indexes. These will be recalculated if the provided schema version differ from the version in the Realm file. WARNING: There is no guarantee that the value inserted here is the same returned by BaseRealm.getVersion(). Due to the nature of synced Realms, the value can both be higher and lower.
    - It will be lower if another client with a lesser schemaVersion connected to the server for the first time after this schemaVersion was used.
    - It will be higher if another client with a higher schemaVersion connected to the server after this Realm was created.
    Parameters:
    
    schemaVersion - the schema version.
    
    Throws:
    
    IllegalArgumentException - if schema version is invalid.
  - modules
```
public SyncConfiguration.Builder modules(Object baseModule,
                                         Object... additionalModules)
```
    Replaces the existing module(s) with one or more RealmModules. Using this method will replace the current schema for this Realm with the schema defined by the provided modules.
    A reference to the default Realm module containing all Realm classes in the project (but not dependencies), can be found using Realm.getDefaultModule(). Combining the schema from the app project and a library dependency is thus done using the following code:
    builder.modules(Realm.getDefaultMode(), new MyLibraryModule());
    
    Parameters:
    
    baseModule - the first Realm module (required).
    
    additionalModules - the additional Realm modules
    
    Throws:
    
    IllegalArgumentException - if any of the modules don't have the RealmModule annotation.
    
    See Also:
    
    Realm.getDefaultModule()
  - modules
```
public SyncConfiguration.Builder modules(Iterable<Object> modules)
```
    Replaces the existing module(s) with one or more RealmModules. Using this method will replace the current schema for this Realm with the schema defined by the provided modules.
    A reference to the default Realm module containing all Realm classes in the project (but not dependencies), can be found using Realm.getDefaultModule(). Combining the schema from the app project and a library dependency is thus done using the following code:
    builder.modules(Realm.getDefaultMode(), new MyLibraryModule());
    
    Parameters:
    
    modules - list of modules tthe first Realm module (required).
    
    Throws:
    
    IllegalArgumentException - if any of the modules don't have the RealmModule annotation.
    
    See Also:
    
    Realm.getDefaultModule()
  - addModule
```
public SyncConfiguration.Builder addModule(Object module)
```
    Adds a module to the already defined modules.
  - rxFactory
```
public SyncConfiguration.Builder rxFactory(RxObservableFactory factory)
```
    Sets the RxObservableFactory used to create Rx Observables from Realm objects. The default factory is RealmObservableFactory.
    
    Parameters:
    
    factory - factory to use.
  - initialData
```
public SyncConfiguration.Builder initialData(Realm.Transaction transaction)
```
    Sets the initial data in Realm. This transaction will be executed only the first time the Realm file is opened (created) or while migrating the data if RealmConfiguration.Builder.deleteRealmIfMigrationNeeded() is set.
    
    Parameters:
    
    transaction - transaction to execute.
  - inMemory
```
public SyncConfiguration.Builder inMemory()
```
    Setting this will create an in-memory Realm instead of saving it to disk. In-memory Realms might still use disk space if memory is running low, but all files created by an in-memory Realm will be deleted when the Realm is closed.
    Note that because in-memory Realms are not persisted, you must be sure to hold on to at least one non-closed reference to the in-memory Realm object with the specific name as long as you want the data to last.
  - errorHandler
```
public SyncConfiguration.Builder errorHandler(SyncSession.ErrorHandler errorHandler)
```
    Sets the error handler used by this configuration. This will override any handler set by calling SyncManager.setDefaultSessionErrorHandler(SyncSession.ErrorHandler).
    Only errors not handled by the defined SyncPolicy will be reported to this error handler.
    
    Parameters:
    
    errorHandler - error handler used to report back errors when communicating with the Realm Object Server.
    
    Throws:
    
    IllegalArgumentException - if null is given as an error handler.
  - trustedRootCA
```
public SyncConfiguration.Builder trustedRootCA(String filename)
```
    Provides the trusted root certificate(s) authority (CA) in PEM format, that should be used to validate the TLS connections to the Realm Object Server.
    The file should be stored under assets, it will be copied at runtime into the internal storage.
    Note: This is similar to passing the parameter CAfile to SSL_CTX_load_verify_locations, Therefore it is recommended to include only the root CA you trust, and not the entire list of root CA as this file will be loaded at runtime. It is your responsibility to download and verify the correct PEM for the root CA you trust. An existing list by Mozilla exist that could be used https://mozillacaprogram.secure.force.com/CA/IncludedCACertificateReportPEMCSV
    
    Parameters:
    
    filename - the path under assets to the root CA.
    
    See Also:
    
    SSL_CTX_load_verify_locations
  - disableSSLVerification
```
public SyncConfiguration.Builder disableSSLVerification()
```
    This will disable TLS certificate verification for the remote Realm Object Server. It is not recommended to use this in production.
    This might be useful in non-production environments where you use a self-signed certificate for testing.
  - waitForInitialRemoteData
```
public SyncConfiguration.Builder waitForInitialRemoteData()
```
    Setting this will cause the Realm to download all known changes from the server the first time a Realm is opened. The Realm will not open until all the data has been downloaded. This means that if a device is offline the Realm will not open.
    Since downloading all changes can be an lengthy operation that might block the UI thread, Realms with this setting enabled should only be opened on background threads or with Realm.getInstanceAsync(RealmConfiguration, Realm.Callback) on the UI thread.
    This check is only enforced the first time a Realm is created. If you otherwise want to make sure a Realm has the latest changes, use SyncSession.downloadAllServerChanges().
  - waitForInitialRemoteData
```
public SyncConfiguration.Builder waitForInitialRemoteData(long timeout,
                                                          TimeUnit unit)
```
    Setting this will cause the Realm to download all known changes from the server the first time a Realm is opened. The Realm will not open until all the data has been downloaded. This means that if a device is offline the Realm will not open.
    Since downloading all changes can be an lengthy operation that might block the UI thread, Realms with this setting enabled should only be opened on background threads or with Realm.getInstanceAsync(RealmConfiguration, Realm.Callback) on the UI thread.
    This check is only enforced the first time a Realm is created. If you otherwise want to make sure a Realm has the latest changes, use SyncSession.downloadAllServerChanges().
    
    Parameters:
    
    timeout - how long to wait for the download to complete before an DownloadingRealmInterruptedException is thrown.
    
    unit - the unit of time used to define the timeout.
  - readOnly
```
public SyncConfiguration.Builder readOnly()
```
    Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an IllegalStateException.
    This in particular mean that initialData(Realm.Transaction) will not work in combination with a read only Realm and setting this will result in a IllegalStateException being thrown.
    Marking a Realm as read only only applies to the Realm in this process. Other processes and devices can still write to the Realm.
  - partialRealm
```
@Deprecated
public SyncConfiguration.Builder partialRealm()
```
    Deprecated. Use SyncUser.createConfiguration(String) instead.
    
    Setting this will open a query-based Realm.
    
    See Also:
    
    SyncConfiguration.isPartialRealm()
  - fullSynchronization
```
public SyncConfiguration.Builder fullSynchronization()
```
    Define this Realm as a fully synchronized Realm.
    Full synchronization, unlike the default query-based synchronization, will transparently synchronize the entire Realm without needing to query for the data. This option is useful if the serverside Realm is small and all the data in the Realm should be available to the user.
  - compactOnLaunch
```
public SyncConfiguration.Builder compactOnLaunch()
```
    Setting this will cause Realm to compact the Realm file if the Realm file has grown too large and a significant amount of space can be recovered. See DefaultCompactOnLaunchCallback for details.
  - compactOnLaunch
```
public SyncConfiguration.Builder compactOnLaunch(CompactOnLaunchCallback compactOnLaunch)
```
    Sets this to determine if the Realm file should be compacted before returned to the user. It is passed the total file size (data + free space) and the bytes used by data in the file.
    
    Parameters:
    
    compactOnLaunch - a callback called when opening a Realm for the first time during the life of a process to determine if it should be compacted before being returned to the user. It is passed the total file size (data + free space) and the bytes used by data in the file.
  - urlPrefix
```
public SyncConfiguration.Builder urlPrefix(String urlPrefix)
```
    The prefix that is prepended to the path in the HTTP request that initiates a sync connection to the Realm Object Server. The value specified must match the server’s configuration otherwise the device will not be able to create a connection. If no value is specified then the default /realm-sync path is used.
    
    Parameters:
    
    urlPrefix - The prefix to append to the sync connection url.
    
    See Also:
    
    Adding a custom proxy
  - clientResyncMode
```
public SyncConfiguration.Builder clientResyncMode(ClientResyncMode mode)
```
    Configure the behavior in case of a Client Resync.
    The default mode is ClientResyncMode.RECOVER_LOCAL_REALM.
    
    Parameters:
    
    mode - what should happen when a Client Resync happens
    
    See Also:
    
    for more information about what a Client Resync is.
  - build
```
public SyncConfiguration build()
```
    Creates the RealmConfiguration based on the builder parameters.
    
    Returns:
    
    the created SyncConfiguration.
    
    Throws:
    
    IllegalStateException - if the configuration parameters are invalid or inconsistent.

Class SyncConfiguration.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

name

directory

encryptionKey

schemaVersion

modules

modules

addModule

rxFactory

initialData

inMemory

errorHandler

trustedRootCA

disableSSLVerification

waitForInitialRemoteData

waitForInitialRemoteData

readOnly

partialRealm

fullSynchronization

compactOnLaunch

compactOnLaunch

urlPrefix

clientResyncMode

build