PimSharedWithMe
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
| Field | Type | Description |
|---|---|---|
collectionId | string | Shared collection ULID |
color | string | null | Hex color code, or null |
components | ('VEVENT' | 'VTODO')[] | null | Supported 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. |
createdAt | number | Timestamp when share was created in epoch seconds |
description | string | null | Collection description, or null |
descriptionLang | string | null | BCP 47 language tag (xml:lang) of the collection description, or null |
displayName | string | null | Display name, or null |
kind | ('calendar' | 'addressbook') | Collection type ('calendar' or 'addressbook') |
name | string | URL slug name |
objectCount | number | Total number of events, tasks, or contacts in this collection |
ownerAddress | string | null | Primary 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 |
ownerIdentityId | string | Identity 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 |
syncToken | string | Current sync token |
taskCounts | PimSharedWithMeTaskCounts | Members 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
| Method | What it does |
|---|---|
pim.listSharedWithMe | List collections shared with mailbox |