Skip to Content

The PimInstance type of the TypeScript SDK, part of PimObjectPageObjectsItem.

type PimInstance = {
  component?: string
  end: number
  fbType?: ('BUSY' | 'BUSY-TENTATIVE') | null
  ownerPartstat?: string | null
  recurrenceId: number | null
  scheduling?: PimInstanceScheduling
  start: number
  status: string | null
  transp: string | null
}

Fields

FieldTypeDescription
componentstringOptional. Standalone iCalendar VCALENDAR text for this occurrence
endnumberOccurrence end timestamp in epoch seconds
fbType('BUSY' | 'BUSY-TENTATIVE') | nullOptional. What this occurrence contributes to a free/busy answer (RFC 4791 §7.10 and the owner's own PARTSTAT), or null for nothing. Present only with fbtype=true
ownerPartstatstring | nullOptional. The collection owner's own PARTSTAT on this occurrence; present only with fbtype=true, null when they are not an attendee of it
recurrenceIdnumber | nullSpecific recurrence-ID timestamp in epoch seconds, or null
schedulingPimInstanceSchedulingOptional. Effective occurrence participants, including RANGE overrides; present with expand=true and fields=json. Missing statuses are not inherited from the master
startnumberOccurrence start timestamp in epoch seconds
statusstring | nullStatus for this occurrence
transpstring | nullTime transparency for this occurrence

Used in

PimObjectPageObjectsItem.

On this page