foo-webview-sdk
    Preparing search index...

    Interface QueueRemoveParams

    Parameters for queue.remove. Remove one entry by index, or several by indices. An empty queue fails with NOT_FOUND whatever is given. An index past the end fails with INVALID_INDEX. In a batch, duplicate indices and those past the end of the queue are skipped; when none is in range the call fails with INVALID_INDEX, the failure carrying removedCount 0 and queueCount. Giving neither key, or a negative index, fails with INVALID_PARAMS.

    interface QueueRemoveParams {
        expectedVersion?: string;
        index?: number;
        indices?: number[];
    }
    Index
    expectedVersion? index? indices?
    expectedVersion?: string

    Expected content version for optimistic concurrency control. When mismatched, mutations are aborted with STALE_TARGET (details.current carries current version). Omitted, no check is made.

    index?: number

    One queue position to remove. Takes precedence over indices.

    indices?: number[]

    Queue positions to remove; read only when index is absent.

    Settings
    Member Visibility

    On This Page
    Properties