Skip to Content

The PimSharedWithMe type of the TypeScript SDK, which pim.listSharedWithMe take or answer.

type PimSharedWithMe = {
  collectionId: string
  color: string | null
  components: ('VEVENT' | 'VTODO')[] | null
  createdAt: number
  description: string | null
  descriptionLang: string | null
  displayName: string | null
  kind: ('calendar' | 'addressbook')
  name: string
  objectCount: number
  ownerAddress: string | null
  ownerIdentityId: string
  permission: ('read' | 'read-write')
  scheduleTransp: ('opaque' | 'transparent')
  syncToken: string
  taskCounts: PimSharedWithMeTaskCounts
}

Fields

FieldTypeDescription
collectionIdstringShared collection ULID
colorstring | nullHex color code, or null
components('VEVENT' | 'VTODO')[] | nullSupported primary components, in VEVENT then VTODO order; null for addressbooks. Legacy mixed calendars may also retain journals or unparsed resources. Narrowing refuses with components_conflict and a count of incompatible live and restorable trashed objects.
createdAtnumberTimestamp when share was created in epoch seconds
descriptionstring | nullCollection description, or null
descriptionLangstring | nullBCP 47 language tag (xml:lang) of the collection description, or null
displayNamestring | nullDisplay name, or null
kind('calendar' | 'addressbook')Collection type ('calendar' or 'addressbook')
namestringURL slug name
objectCountnumberTotal number of events, tasks, or contacts in this collection
ownerAddressstring | nullPrimary email address of the owner, or null for an address-less identity. The mirror of SharedMailbox.ownerAddress: a "shared with me" list names WHO shared
ownerIdentityIdstringIdentity ULID of the collection owner
permission('read' | 'read-write')Access permission level
scheduleTransp('opaque' | 'transparent')RFC 6638 §9.1 CALDAV:schedule-calendar-transp, as the OWNER set it — whether this calendar counts toward their free/busy
syncTokenstringCurrent sync token
taskCountsPimSharedWithMeTaskCountsMembers that are tasks, split by the two progress buckets. Exact complements; events and contacts are in neither, so the pair need not sum to objectCount.

Used by

MethodWhat it does
pim.listSharedWithMeList collections shared with mailbox

On this page