QueueSnapshot<T> class

The state of a queue when an event happened, sent on the queue's onUpdate stream.

The queue's flags and times are as they were at the event, and eventItem is a copy of the item involved, taken at that moment. items is different: unless the queue copies items into snapshots, it holds the queue's live items, which keep changing.

Constructors

QueueSnapshot({required QueueEvent event, required int retries, required bool isStarted, required bool isProcessing, required String currentBatchId, required QueueItem<T>? eventItem, required Iterable<QueueItem<T>> items, required DateTime? startedAt, required DateTime? startedProcessingAt, required DateTime? stoppedProcessingAt, required DateTime? stoppedAt})
Creates a snapshot. Queues create them; you don't need to.
const

Properties

currentBatchId → String
The queue's current batch id.
final
event → QueueEvent
The event that triggered the snapshot.
final
eventItem → QueueItem<T>?
A copy of the item the event is about, taken at the time of the event, or null for events about the whole queue.
final
hashCode → int
The hash code for this object.
no setterinherited
isProcessing → bool
Whether the queue was processing items.
final
isStarted → bool
Whether the queue had been started.
final
items → Iterable<QueueItem<T>>
The items in the queue's current batch.
final
retries → int
The number of times the queue retries a failed item.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startedAt → DateTime?
When the queue was last started.
final
startedProcessingAt → DateTime?
When the queue last started processing items.
final
stoppedAt → DateTime?
When the queue was last stopped.
final
stoppedProcessingAt → DateTime?
When the queue last stopped processing items.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited