Skip to Content

The PimPublicCollection type of the TypeScript SDK, which pim.listPublicDirectory and 2 more methods take or answer.

type PimPublicCollection = {
  category: string | null
  collectionId: string
  components: ('VEVENT' | 'VTODO')[] | null
  createdAt: number
  description: string | null
  displayName: string | null
  id: string
  kind: ('calendar' | 'addressbook')
  ownerIdentityId: string
}

Fields

FieldTypeDescription
categorystring | nullPublic category tag, or null
collectionIdstringPublic collection ULID
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.
createdAtnumberCreation timestamp in epoch seconds
descriptionstring | nullPublic description, or null
displayNamestring | nullPublic display name, or null
idstringDirectory entry id: the handle POST /subscriptions takes
kind('calendar' | 'addressbook')Collection type ('calendar' or 'addressbook')
ownerIdentityIdstringIdentity ULID of the owner

Used by

MethodWhat it does
pim.listPublicDirectoryBrowse account public directory
pim.subscribeSubscribe to public collection
pim.listSubscriptionsList public collection subscriptions

On this page