Offline measurement background sync

Generated reference for ovok_flutter: offline measurement background sync.

  • Stable unknown
  • Release candidate since 0.1.0-rc.6
  • Development since 0.1.0-dev.32+1028d01

OfflineMeasurementBackgroundSyncOptions

class OfflineMeasurementBackgroundSyncOptions

Options for recurring offline measurement sync.

Constructors

OfflineMeasurementBackgroundSyncOptions.new

OfflineMeasurementBackgroundSyncOptions({int minimumIntervalMinutes = minimumOfflineMeasurementBackgroundSyncIntervalMinutes})

Minimum repeat interval in minutes; defaults to the platform minimum.

ParameterTypeKindDefault
minimumIntervalMinutesintnamedminimumOfflineMeasurementBackgroundSyncIntervalMinutes

Properties

OfflineMeasurementBackgroundSyncOptions.minimumIntervalMinutes

final int minimumIntervalMinutes

Minimum interval requested from the operating system.

cancelOfflineMeasurementBackgroundSync

Future<void> cancelOfflineMeasurementBackgroundSync()

Cancels recurring offline measurement sync.

minimumOfflineMeasurementBackgroundSyncIntervalMinutes

int get minimumOfflineMeasurementBackgroundSyncIntervalMinutes

offlineMeasurementBackgroundTaskName

String get offlineMeasurementBackgroundTaskName

registerOfflineMeasurementBackgroundTask

Future<bool> Function() registerOfflineMeasurementBackgroundTask(Future<Ovok> Function() restoreClient)

Creates a handler for the app's Workmanager callback dispatcher.

Call this from the dispatcher so restoreClient runs in the background isolate and restores the host app's secure session.

ParameterTypeKindDefault
restoreClientFuture<Ovok> Function()positional

runOfflineMeasurementBackgroundSync

Future<OfflineMeasurementFlushResult> runOfflineMeasurementBackgroundSync(Ovok client)

Flushes the Core offline measurement queue for a restored client.

ParameterTypeKindDefault
clientOvokpositional

scheduleOfflineMeasurementBackgroundSync

Future<void> scheduleOfflineMeasurementBackgroundSync({OfflineMeasurementBackgroundSyncOptions options = const OfflineMeasurementBackgroundSyncOptions()})

Schedules recurring offline measurement sync at the requested interval.

ParameterTypeKindDefault
optionsOfflineMeasurementBackgroundSyncOptionsnamedconst OfflineMeasurementBackgroundSyncOptions()

Last updated on

On this page