Sync class

ObjectBox Sync makes data available and synchronized across devices, online and offline.

Start a client using Sync.client() and connect to a remote server.

Constructors

Sync({bool sharedGlobalIds = false})

Enables sync for an @Entity class.

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sharedGlobalIds → bool

Set to true to enable shared global IDs for a Sync-enabled entity class.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

client(Store store, String serverUrl, SyncCredentials credentials) → SyncClient

Creates a Sync client associated with the given store and configures it with the given options. This does not initiate any connection attempts yet, call SyncClient.start() to do so.

clientMultiUrls(Store store, List<String> serverUrls, SyncCredentials credentials) → SyncClient

Like client, but accepts a list of URLs to work with multiple servers.

isAvailable() → bool

Returns true if the loaded ObjectBox native library supports Sync.