Interface QueueGetSuccess

Successful response from queue.get.

interface QueueGetSuccess {
    contentVersion: string;
    count: number;
    items: QueueItem[];
    success: true;
}

Properties

contentVersion: string

Pass it as expectedVersion so that a queue changed meanwhile fails the call instead of hitting other entries.

count: number

Number of entries.

The entries, in play order.

success: true

Always true here; a failed call resolves with ApiFailure instead.