DatumSyncOptions<T extends DatumEntityBase> class

Configuration passed when triggering a manual synchronization via Datum.sync().

Annotations
  • @immutable

Constructors

DatumSyncOptions({bool includeDeletes = true, bool resolveConflicts = true, bool forceFullSync = false, int? overrideBatchSize, Duration? timeout, SyncDirection? direction, DatumConflictResolver<T>? conflictResolver})
Creates sync options to customize a manual sync cycle.
const

Properties

conflictResolver DatumConflictResolver<T>?
A conflict resolver to override the default for this sync only.
final
direction SyncDirection?
The order of synchronization operations for this sync, overriding the default.
final
forceFullSync bool
If true, forces a full pull of all remote data, ignoring local metadata.
final
hashCode int
The hash code for this object.
no setteroverride
includeDeletes bool
Whether to include delete operations in the sync.
final
overrideBatchSize int?
A custom batch size for this sync, overriding the one in DatumConfig.
final
resolveConflicts bool
Whether to automatically resolve conflicts using the configured resolver.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
timeout Duration?
A timeout for this specific sync operation, overriding the one inDatumConfig .
final

Methods

copyWith({bool? includeDeletes, bool? resolveConflicts, bool? forceFullSync, int? overrideBatchSize, Duration? timeout, SyncDirection? direction, DatumConflictResolver<T>? conflictResolver}) DatumSyncOptions<T>
Creates a new instance with the specified values, allowing for a change in the generic type.
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.
override