Sync progress
Generated reference for ovok_flutter: sync progress.
- Stable unknown
- Release candidate since 0.1.0-rc.6
- Development since 0.1.0-dev.32+1028d01
SyncPauseReason
enum SyncPauseReasonWhy a sync run is paused.
Values
SyncPauseReason.offline
static const SyncPauseReason offlineThe device has no network connection.
SyncPauseReason.wifiOnly
static const SyncPauseReason wifiOnlySync is waiting for an unmetered connection.
SyncProgress
class SyncProgressSync state for one data type.
Constructors
SyncProgress.new
SyncProgress({
required String measurementTypeKey,
required SyncProgressStatus status,
SyncPauseReason? reason,
SyncProgressCounts? progress,
})Creates a sync progress snapshot.
| Parameter | Type | Kind | Default |
|---|---|---|---|
measurementTypeKey | String | required named | |
status | SyncProgressStatus | required named | |
reason | SyncPauseReason? | named | |
progress | SyncProgressCounts? | named |
Properties
SyncProgress.measurementTypeKey
final String measurementTypeKeyData type being synced.
SyncProgress.status
final SyncProgressStatus statusCurrent sync stage.
SyncProgress.reason
final SyncPauseReason? reasonWhy a paused sync is waiting.
SyncProgress.progress
final SyncProgressCounts? progressRecords processed and remaining.
SyncProgressCounts
class SyncProgressCountsCounts for one data type in a sync run.
Constructors
SyncProgressCounts.new
SyncProgressCounts({
required int done,
required int total,
int? created,
})Creates sync counts.
| Parameter | Type | Kind | Default |
|---|---|---|---|
done | int | required named | |
total | int | required named | |
created | int? | named |
Properties
SyncProgressCounts.done
final int doneRecords processed so far.
SyncProgressCounts.total
final int totalRecords to process.
SyncProgressCounts.created
final int? createdObservations created rather than matched or updated.
SyncProgressStatus
enum SyncProgressStatusCurrent sync stage for one data type.
Values
SyncProgressStatus.started
static const SyncProgressStatus startedA sync run has started.
SyncProgressStatus.completed
static const SyncProgressStatus completedAll available records were processed.
SyncProgressStatus.failed
static const SyncProgressStatus failedThe sync run stopped after an error.
SyncProgressStatus.idle
static const SyncProgressStatus idleNo sync run is active.
SyncProgressStatus.syncing
static const SyncProgressStatus syncingRecords are being read or saved.
SyncProgressStatus.paused
static const SyncProgressStatus pausedThe sync run is waiting to resume.
Last updated on