Skip to Content

The PimObjectMeta type of the TypeScript SDK, part of PimObjectJson and 2 more types.

type PimObjectMeta = {
  attendees: PimAttendee[] | null
  component: ('VEVENT' | 'VTODO' | 'VJOURNAL' | 'VCARD') | null
  contentType: string
  createdAt: number
  dtend: number | null
  dtstart: number | null
  etag: string
  eventStatus: string | null
  href: string
  id: string
  organizer: string | null
  rrule: string | null
  sequence: number
  size: number
  transp: string | null
  uid: string
  updatedAt: number
  vcardEmail: string | null
  vcardFn: string | null
  vcardN: string | null
}

Fields

FieldTypeDescription
attendeesPimAttendee[] | nullList of parsed attendees, or null
component('VEVENT' | 'VTODO' | 'VJOURNAL' | 'VCARD') | nullMain component type
contentTypestringMIME content type (text/calendar or text/vcard)
createdAtnumberCreation timestamp in epoch seconds
dtendnumber | nullEvent end timestamp in epoch seconds, or null
dtstartnumber | nullEvent start timestamp in epoch seconds, or null
etagstringSHA-256 hash of object body (strong ETag)
eventStatusstring | nullEvent status (CONFIRMED, TENTATIVE, CANCELLED), or null
hrefstringDAV resource path name (e.g. 'event-123.ics')
idstringObject ULID
organizerstring | nullOrganizer email address, or null
rrulestring | nullRecurrence rule (RRULE string), or null
sequencenumberiCalendar revision sequence number
sizenumberObject size in bytes
transpstring | nullTime transparency (OPAQUE for busy, TRANSPARENT for free), or null
uidstringiCalendar or vCard UID
updatedAtnumberLast updated timestamp in epoch seconds
vcardEmailstring | nullvCard primary email address, or null
vcardFnstring | nullvCard full formatted name (FN), or null
vcardNstring | nullvCard structured name (family;given;additional;prefix;suffix), or null

Used in

PimObjectJson, PimObjectPageObjectsItem, PimTrashedObject.

On this page