QueueInsertItemOptions
Optional settings for inserting a queue item, plus folder scoping
(folderId / folderKey / folderPath).
Extends¶
Properties¶
| Property | Type | Description |
|---|---|---|
deferDate? |
Date |
The item is hidden from consumers until this time — processing does not start before it. |
dueDate? |
Date |
The time by which the item should be processed (drives queue SLA tracking). |
expand? |
string |
- |
folderId? |
number |
Numeric folder ID. |
folderKey? |
string |
Folder key (GUID-formatted string). |
folderPath? |
string |
Slash-delimited folder path, e.g. 'Shared/Finance'. |
priority? |
QueuePriority |
Processing priority used when the item is picked up by a consumer. Defaults to QueuePriority.Normal. |
progress? |
string |
Free-form progress text stored on the queue item. |
reference? |
string |
User-defined business identifier for the item (e.g. an invoice number). Used for searching/filtering items and, when the queue has enforceUniqueReference enabled, for rejecting duplicate items. |
riskSlaDate? |
Date |
The time after which unprocessed items are considered at risk of breaching the SLA. |
select? |
string |
- |