Skip to Content

The PimObjectJson type of the TypeScript SDK, which calendarObjects.get and addressbookObjects.get take or answer.

type PimObjectJson = PimObjectMeta & {
  content?: string
  data: Record<string, unknown> | null
  writable: boolean
}

Fields

FieldTypeDescription
contentstringOptional. The wire text; present only when data is null
dataRecord<string, unknown> | nullJSCalendar Event or Task (RFC 8984) or JSContact Card (RFC 9553); null when unmapped
writablebooleanFalse when the object converts TO JSON but cannot be converted back — display-only. The reader is more permissive than the writer (e.g. a VEVENT with no DTSTART reads fine and can never be written), so this says up front that an edit would be refused

Used by

MethodWhat it does
calendarObjects.getGet calendar object
addressbookObjects.getGet addressbook object

On this page