PimPutResult
The PimPutResult type of the TypeScript SDK, which calendarObjects.put and addressbookObjects.put take or answer.
type PimPutResult = {
created: boolean
etag: string
href: string
id: string
merged?: boolean
rewritten?: boolean
syncToken: string
unparsed?: boolean
}Fields
| Field | Type | Description |
|---|---|---|
created | boolean | True if a new object was created (false if replaced) |
etag | string | Strong ETag SHA-256 hash |
href | string | DAV resource path name |
id | string | Object ULID |
merged | boolean | Optional. True when the difference reported by rewritten is other people's answers: a matching If-Schedule-Tag-Match had the server carry its own ATTENDEE state (PARTSTAT, RSVP, SCHEDULE-STATUS) for every attendee but the owner onto the new body (RFC 6638 §3.2.10.1) |
rewritten | boolean | Optional. True when the stored bytes are not the bytes sent, whatever the cause: the VCALENDAR-level METHOD was dropped (RFC 4791 §4.1), SCHEDULE-FORCE-SEND was dropped (RFC 6638 §7.2), or attendee state was merged in (see merged). The etag returned is the stored body's, so re-read before relying on a cached copy — and a DAV gateway must withhold the strong ETag (RFC 4791 §5.3.4) |
syncToken | string | Updated collection sync token |
unparsed | boolean | Optional. True if stored object body could not be parsed into structured fields |
Used by
| Method | What it does |
|---|---|
calendarObjects.put | Create or replace calendar object |
addressbookObjects.put | Create or replace addressbook object |