QueueMethods
Queue methods interface - operations bound to a queue returned by getAll/getById. The queue's own id, name, and folder are filled in automatically.
Methods¶
getAllItems()¶
getAllItems<
T>(options?:T):Promise<TextendsHasPaginationOptions<T> ?PaginatedResponse<QueueItem> :NonPaginatedResponse<QueueItem>>
Gets this queue's items with optional filtering and pagination.
Type Parameters¶
| Type Parameter | Default type |
|---|---|
T extends QueueGetAllItemsOptions |
QueueGetAllItemsOptions |
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
T |
Query options including filtering and pagination options |
Returns¶
Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<QueueItem> : NonPaginatedResponse<QueueItem>>
Promise resolving to the queue's QueueItem entries
insertItem()¶
insertItem(
specificData:Record<string,QueueItemValue>,options?:QueueInsertItemOptions):Promise<QueueItem>
Inserts a new item into this queue.
The payload must be flat — nested objects and arrays are rejected.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
specificData |
Record<string, QueueItemValue> |
The item's business payload (keys are stored exactly as provided) |
options? |
QueueInsertItemOptions |
Optional item metadata (priority, reference, defer/due dates) |
Returns¶
Promise<QueueItem>
Promise resolving to the created QueueItem