SyncService class abstract

Available extensions

• SyncServiceWaitUntilCaughtUp

Constructors

SyncService()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

isSyncInProgress → bool

Returns true if sync is in-progress; else false.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addProgressListener(SyncProgressListener listener) → void

Adds a listener that is notified about SyncProgress

isInSync() → Future<bool>

Returns true if local and cloud secondary are in sync. false otherwise

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeAllProgressListeners() → void

Remove all progress listeners

removeProgressListener(SyncProgressListener listener) → void

Removes a sync progress listener

setOnDone(Function onDone) → void

Call this method to set the Global onDone callback. This method will be called when a sync is completed. When a specific onDone function is passed to the sync Function, Then the specific onDone is called.

sync({Function? onDone, Function? onError}) → void

Sync local secondary and cloud secondary.

toString() → String

A string representation of this object.

inherited

waitUntilCaughtUp({Duration? timeout, void onProgress(SyncProgress progress)?}) → Future<void>

Available on SyncService, provided by the SyncServiceWaitUntilCaughtUp extension

Returns a Future that completes once the local commit id has caught up to the remote commit id as it stood at the time of this call. Captures the remote commit id reported by the first SyncProgress event that fires after the call and completes the future once a subsequent event reports localCommitId >= snapshotServerCommitId. New remote changes that arrive after the call do NOT extend the wait.

Operators

operator ==(Object other) → bool

The equality operator.

inherited