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()

Create a Sync annotation, enabling synchronization for an entity.

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

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 serverUri, SyncCredentials creds) → 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.

isAvailable() → bool

Returns true if the loaded ObjectBox native library supports Sync.