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 OfflineMeasurementFailure

Why 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.

ParameterTypeKindDefault
nameStringrequired named
codeString?named
statusint?named

OfflineMeasurementFailure.fromJson

OfflineMeasurementFailure.fromJson(JsonMap json)

Reads a failure stored by toJson.

ParameterTypeKindDefault
jsonJsonMappositional

Properties

OfflineMeasurementFailure.name

final String name

The error's type, e.g. OvokServiceException.

OfflineMeasurementFailure.code

final String? code

The condition the server named, when known.

OfflineMeasurementFailure.status

final int? status

The HTTP status, when known.

Methods

OfflineMeasurementFailure.toJson

JsonMap toJson()

The failure as stored in the queue.

Returns JsonMap.

OfflineMeasurementFlushOptions

class OfflineMeasurementFlushOptions

Which queued saves a flush retries.

Constructors

OfflineMeasurementFlushOptions.new

OfflineMeasurementFlushOptions({bool includeExhausted = false, bool resetExhausted = false})

Options; the defaults retry only saves that are due.

ParameterTypeKindDefault
includeExhaustedboolnamedfalse
resetExhaustedboolnamedfalse

Properties

OfflineMeasurementFlushOptions.includeExhausted

final bool includeExhausted

Also retry saves that used up their attempts.

OfflineMeasurementFlushOptions.resetExhausted

final bool resetExhausted

Give saves that used up their attempts a fresh set.

OfflineMeasurementFlushResult

class OfflineMeasurementFlushResult

What 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.

ParameterTypeKindDefault
attemptedintrequired named
savedintrequired named
queuedintrequired named
exhaustedintrequired named
responsesMap<String, Map<String, dynamic>>required named
failuresMap<String, OfflineMeasurementFailure>required named

Properties

OfflineMeasurementFlushResult.attempted

final int attempted

Saves sent in this flush.

OfflineMeasurementFlushResult.saved

final int saved

Saves that succeeded and left the queue.

OfflineMeasurementFlushResult.queued

final int queued

Saves still waiting: not yet due, failed again, or another account's.

OfflineMeasurementFlushResult.exhausted

final int exhausted

Saves that used up their attempts.

OfflineMeasurementFlushResult.responses

final Map<String, Map<String, dynamic>> responses

The server's response per saved queue id.

OfflineMeasurementFlushResult.failures

final Map<String, OfflineMeasurementFailure> failures

The last failure per queue id that is still queued.

OfflineMeasurementQueueApi

class OfflineMeasurementQueueApi

Saves 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.

ParameterTypeKindDefault
_flushFuture<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.

ParameterTypeKindDefault
optionsOfflineMeasurementFlushOptionsoptional positionalconst OfflineMeasurementFlushOptions()

Returns Future<OfflineMeasurementFlushResult>.

Last updated on

On this page