# Offline measurement background sync

Canonical page: https://docs.ovok.com/flutter-sdk/reference/ovok_flutter/offline-measurement-background-sync

{/* Generated by scripts/generate_reference.dart; do not edit. */}

## OfflineMeasurementBackgroundSyncOptions [#offlinemeasurementbackgroundsyncoptions]

```dart
class OfflineMeasurementBackgroundSyncOptions
```

Options for recurring offline measurement sync.

### Constructors [#constructors]

#### OfflineMeasurementBackgroundSyncOptions.new [#offlinemeasurementbackgroundsyncoptionsnew]

```dart
OfflineMeasurementBackgroundSyncOptions({int minimumIntervalMinutes = minimumOfflineMeasurementBackgroundSyncIntervalMinutes})
```

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `minimumIntervalMinutes` | `int` | named | `minimumOfflineMeasurementBackgroundSyncIntervalMinutes` |

### Properties [#properties]

#### OfflineMeasurementBackgroundSyncOptions.minimumIntervalMinutes [#offlinemeasurementbackgroundsyncoptionsminimumintervalminutes]

```dart
final int minimumIntervalMinutes
```

Minimum interval requested from the operating system.


## cancelOfflineMeasurementBackgroundSync [#cancelofflinemeasurementbackgroundsync]

```dart
Future<void> cancelOfflineMeasurementBackgroundSync()
```

Cancels recurring offline measurement sync.


## minimumOfflineMeasurementBackgroundSyncIntervalMinutes [#minimumofflinemeasurementbackgroundsyncintervalminutes]

```dart
int get minimumOfflineMeasurementBackgroundSyncIntervalMinutes
```


## offlineMeasurementBackgroundTaskName [#offlinemeasurementbackgroundtaskname]

```dart
String get offlineMeasurementBackgroundTaskName
```


## registerOfflineMeasurementBackgroundTask [#registerofflinemeasurementbackgroundtask]

```dart
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.

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `restoreClient` | `Future<Ovok> Function()` | positional |  |


## runOfflineMeasurementBackgroundSync [#runofflinemeasurementbackgroundsync]

```dart
Future<OfflineMeasurementFlushResult> runOfflineMeasurementBackgroundSync(Ovok client)
```

Flushes the Core offline measurement queue for a restored client.

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `client` | `Ovok` | positional |  |


## scheduleOfflineMeasurementBackgroundSync [#scheduleofflinemeasurementbackgroundsync]

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

Schedules recurring offline measurement sync at the requested interval.

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `options` | `OfflineMeasurementBackgroundSyncOptions` | named | `const OfflineMeasurementBackgroundSyncOptions()` |