Participants and alarms
Events, todos, and journals provide organizers and attendees. Events and todos also provide alarms.
Organizer
Organizer represents one ORGANIZER property.
| Member | Type | Meaning |
|---|---|---|
address | string | Original cal-address, including mailto: when present. |
email | ?string | Address without the case-insensitive mailto: prefix; otherwise null. |
name | ?string | CN parameter. |
sentBy | ?string | SENT-BY parameter. |
directory | ?string | DIR parameter. |
parameters() | array<string,string|list<string>> | Every parameter, including unknown ones. |
Attendee
Attendee represents one repeated ATTENDEE property. Attendees are not merged by address.
| Member | Type | Meaning |
|---|---|---|
address | string | Original cal-address. |
email, name | ?string | Address without mailto: and the CN display name. |
role, status, type | ?string | Uppercase ROLE, PARTSTAT, and CUTYPE. |
rsvp | ?bool | TRUE, FALSE, or null when absent or unrecognized. |
delegatedFrom, delegatedTo | Collection<int,string> | Every delegation address. |
parameters() | array<string,string|list<string>> | Every parameter, including unknown ones. |
Alarm and trigger
Each Alarm represents one VALARM inside an event or todo.
| Member | Type | Meaning |
|---|---|---|
action | ?string | ACTION. |
trigger | ?AlarmTrigger | Relative or absolute TRIGGER. |
description, summary | ?string | Reminder text. |
attendees | Collection<int, Attendee> | Repeated alarm attendees in document order. |
attachments | Collection<int, Property> | Repeated ATTACH properties in document order. |
repeat | ?int | REPEAT count. |
duration | ?DateInterval | Time between repeats. |
properties(), property(), hasProperty() | Collection / ?Property / bool | Query direct properties or check whether they exist. |
rawComponent() | VAlarm | The low-level alarm component. |
php
$trigger = $event->alarms->first()?->trigger;
$trigger?->isRelative(); // ?bool
$trigger?->isAbsolute(); // ?bool
$trigger?->duration(); // ?DateInterval
$trigger?->dateTime(); // ?CarbonImmutable
$trigger?->relatedTo(); // START, END, or nullFor a relative trigger, duration() is the offset before or after the related event or todo boundary, and relatedTo() identifies its start or end. For an absolute trigger, dateTime() is the reminder time. Use property('TRIGGER') for its value and parameters, or rawComponent() for the complete alarm.