Package io.objectbox.sync

@ParametersAreNonnullByDefault package io.objectbox.sync

ObjectBox Sync allows to automatically synchronize local data with a sync destination (e.g. a sync server) and vice versa. This is the sync client package.

These are the typical steps to setup a sync client:

1. Create a BoxStore as usual (using MyObjectBox).
2. Get a SyncBuilder using Sync.client(boxStore, url, credentials). Here you need to pass the BoxStore, along with an URL to the sync destination (server), and credentials. For demo set ups, you could start with SyncCredentials.none() credentials.
3. Optional: use the SyncBuilder instance from the last step to configure the sync client and set initial listeners.
4. Call SyncBuilder.build() to get an instance of SyncClient (and hold on to it). Synchronization is now active.
5. Optional: Interact with SyncClient.

Related Packages

Package	Description
io.objectbox	ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
io.objectbox.sync.internal
io.objectbox.sync.listener
io.objectbox.sync.server

Class	Description
ConnectivityMonitor	Used by SyncClient to observe connectivity changes.
Credentials	Credentials consist of a type and the credentials data to perform authentication checks.
Credentials.Vector
CredentialsType	Credentials types for login at a sync server.
ObjectsMessageBuilder
Sync	ObjectBox Sync makes data available on other devices.
SyncBuilder	A builder to create a SyncClient; the builder itself should be created via Sync.client(BoxStore, String, SyncCredentials).
SyncBuilder.RequestUpdatesMode
SyncChange	A collection of changes made to one entity type during a sync transaction.
SyncClient	ObjectBox sync client.
SyncClientImpl	Internal sync client implementation.
SyncClientImpl.ObjectsMessageBuilderImpl
SyncCredentials	Use the static helper methods to build Sync credentials, for example SyncCredentials.sharedSecret("secret").
SyncCredentials.CredentialsType
SyncCredentialsToken	Internal credentials implementation.
SyncCredentialsUserPassword	Internal credentials implementation for user and password authentication.
SyncFlags	Flags to adjust sync behavior like additional logging.
SyncHybrid	Combines the functionality of a Sync client and a Sync server.
SyncHybridBuilder	Builder for a Sync client and server hybrid setup, a SyncHybrid.
SyncLoginCodes	Codes used by SyncLoginListener.onLoginFailed(long).
SyncState	Returned by SyncClientImpl.getSyncState().