Interface QueueRemoveSuccess

Successful response from queue.remove.

interface QueueRemoveSuccess {
    contentVersion: string;
    queueCount: number;
    removedCount?: number;
    removedIndex?: number;
    success: true;
}

Properties

contentVersion: string

Already includes this change; pass it as expectedVersion to the next call.

queueCount: number

Queue length afterwards.

removedCount?: number

How many entries were removed; only when indices was given.

removedIndex?: number

The position removed; only when index was given.

success: true

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