BatchUpdateEntry
The BatchUpdateEntry type of the TypeScript SDK, part of BatchUpdateResult.
type BatchUpdateEntry = {
currentModseq?: number
expungedAt?: number
id: string
labelsAdded?: string[]
labelsRemoved?: string[]
message?: MessageMeta
modified?: boolean
modseq?: number
purgeAfter?: number
status: ('updated' | 'expunged' | 'not_found' | 'not_in_label' | 'too_many_keywords' | 'modified')
}Fields
| Field | Type | Description |
|---|---|---|
currentModseq | number | Optional. Current message MODSEQ value on CAS conflict |
expungedAt | number | Optional. Expunge timestamp in epoch seconds (when status=expunged) |
id | string | Message ULID |
labelsAdded | string[] | Optional. Labels attached by this write |
labelsRemoved | string[] | Optional. Labels detached by this write |
message | MessageMeta | Optional. Updated message metadata (when status=updated) |
modified | boolean | Optional. True if CAS check failed due to concurrent modification |
modseq | number | Optional. Updated or current MODSEQ value |
purgeAfter | number | Optional. Purge deadline timestamp in epoch seconds (when status=expunged) |
status | ('updated' | 'expunged' | 'not_found' | 'not_in_label' | 'too_many_keywords' | 'modified') | Outcome status for this message. not_in_label: the patch named a flagLabel this message is not filed in, so nothing was written for it |