Offline measurement queue
Generated reference for ovok_sdk: offline measurement queue.
- Stable unknown
- Release candidate since 0.1.0-rc.4
- Development since 0.1.0-dev.23+d339d81
OfflineMeasurementFailure
class OfflineMeasurementFailureWhy a queued save last failed.
Constructors
OfflineMeasurementFailure.new
OfflineMeasurementFailure({
required String name,
String? code,
int? status,
})A failure named name, with the server's code and status when known.
| Parameter | Type | Kind | Default |
|---|---|---|---|
name | String | required named | |
code | String? | named | |
status | int? | named |
OfflineMeasurementFailure.fromJson
OfflineMeasurementFailure.fromJson(JsonMap json)Reads a failure stored by toJson.
| Parameter | Type | Kind | Default |
|---|---|---|---|
json | JsonMap | positional |
Properties
OfflineMeasurementFailure.name
final String nameThe error's type, e.g. OvokServiceException.
OfflineMeasurementFailure.code
final String? codeThe condition the server named, when known.
OfflineMeasurementFailure.status
final int? statusThe HTTP status, when known.
Methods
OfflineMeasurementFailure.toJson
JsonMap toJson()The failure as stored in the queue.
Returns JsonMap.
OfflineMeasurementFlushOptions
class OfflineMeasurementFlushOptionsWhich queued saves a flush retries.
Constructors
OfflineMeasurementFlushOptions.new
OfflineMeasurementFlushOptions({bool includeExhausted = false, bool resetExhausted = false})Options; the defaults retry only saves that are due.
| Parameter | Type | Kind | Default |
|---|---|---|---|
includeExhausted | bool | named | false |
resetExhausted | bool | named | false |
Properties
OfflineMeasurementFlushOptions.includeExhausted
final bool includeExhaustedAlso retry saves that used up their attempts.
OfflineMeasurementFlushOptions.resetExhausted
final bool resetExhaustedGive saves that used up their attempts a fresh set.
OfflineMeasurementFlushResult
class OfflineMeasurementFlushResultWhat a flush of the offline queue did.
Constructors
OfflineMeasurementFlushResult.new
OfflineMeasurementFlushResult({
required int attempted,
required int saved,
required int queued,
required int exhausted,
required Map<String, JsonMap> responses,
required Map<String, OfflineMeasurementFailure> failures,
})A flush result.
| Parameter | Type | Kind | Default |
|---|---|---|---|
attempted | int | required named | |
saved | int | required named | |
queued | int | required named | |
exhausted | int | required named | |
responses | Map<String, Map<String, dynamic>> | required named | |
failures | Map<String, OfflineMeasurementFailure> | required named |
Properties
OfflineMeasurementFlushResult.attempted
final int attemptedSaves sent in this flush.
OfflineMeasurementFlushResult.saved
final int savedSaves that succeeded and left the queue.
OfflineMeasurementFlushResult.queued
final int queuedSaves still waiting: not yet due, failed again, or another account's.
OfflineMeasurementFlushResult.exhausted
final int exhaustedSaves that used up their attempts.
OfflineMeasurementFlushResult.responses
final Map<String, Map<String, dynamic>> responsesThe server's response per saved queue id.
OfflineMeasurementFlushResult.failures
final Map<String, OfflineMeasurementFailure> failuresThe last failure per queue id that is still queued.
OfflineMeasurementQueueApi
class OfflineMeasurementQueueApiSaves waiting to be retried. Reached through ovok.measurements.offlineQueue.
Constructors
OfflineMeasurementQueueApi.new
OfflineMeasurementQueueApi(Future<OfflineMeasurementFlushResult> Function(OfflineMeasurementFlushOptions) _flush)Built by MeasurementsResource; use ovok.measurements.offlineQueue instead.
| Parameter | Type | Kind | Default |
|---|---|---|---|
_flush | Future<OfflineMeasurementFlushResult> Function(OfflineMeasurementFlushOptions) | positional |
Methods
OfflineMeasurementQueueApi.flush
Future<OfflineMeasurementFlushResult> flush([OfflineMeasurementFlushOptions options = const OfflineMeasurementFlushOptions()])Retries the signed-in account's queued saves that are due.
A save is tried up to 8 times, with a backoff from 5 seconds doubling up to an hour; failures are recorded, not thrown.
| Parameter | Type | Kind | Default |
|---|---|---|---|
options | OfflineMeasurementFlushOptions | optional positional | const OfflineMeasurementFlushOptions() |
Returns Future<OfflineMeasurementFlushResult>.
Last updated on