| Methods |
public
static
|
display(
string $description,
DateInterval|DateTimeInterface|DateTimeValue|string $trigger,
'START'|'END'|'start'|'end' $related = 'START',
?int $repeat = null,
DateInterval|string|null $duration = null,
?string $uid = null,
PropertyList $properties = [],
): self
An alarm displaying the description.
An alarm displaying the description.
Parameters
| $properties |
other properties, see Event::new()
|
Throws
|
#
|
public
static
|
audio(
DateInterval|DateTimeInterface|DateTimeValue|string $trigger,
?string $sound = null,
'START'|'END'|'start'|'end' $related = 'START',
?int $repeat = null,
DateInterval|string|null $duration = null,
?string $uid = null,
PropertyList $properties = [],
): self
An alarm playing a sound, the default one of the program when $sound (a URI) is null.
An alarm playing a sound, the default one of the program when $sound (a URI) is null.
Throws
|
#
|
public
static
|
email(
string $summary,
string $description,
iterable<CalAddress|string> $attendees,
DateInterval|DateTimeInterface|DateTimeValue|string $trigger,
iterable<string> $attachments = [],
'START'|'END'|'start'|'end' $related = 'START',
?int $repeat = null,
DateInterval|string|null $duration = null,
?string $uid = null,
PropertyList $properties = [],
): self
An alarm sending an e-mail with the summary as the subject and the description as the body
to at least one attendee.
An alarm sending an e-mail with the summary as the subject and the description as the body
to at least one attendee.
Parameters
Throws
|
#
|
public
|
property(string $name): ?Property
|
#
|
public
|
uid(): ?string
UID of the alarm (RFC 9074, section 4).
UID of the alarm (RFC 9074, section 4).
|
#
|
public
|
action(): ?string
ACTION: AUDIO, DISPLAY or EMAIL.
ACTION: AUDIO, DISPLAY or EMAIL.
|
#
|
public
|
trigger(): DateInterval|DateTimeValue|null
TRIGGER: a duration relative to the start (or end, see related()), or an absolute time.
TRIGGER: a duration relative to the start (or end, see related()), or an absolute time.
|
#
|
public
|
related(): string
RELATED parameter of a relative trigger: START (default) or END.
RELATED parameter of a relative trigger: START (default) or END.
|
#
|
public
|
acknowledged(): ?DateTimeValue
ACKNOWLEDGED (RFC 9074, section 6): when the alarm was last acknowledged (or sent), in UTC.
ACKNOWLEDGED (RFC 9074, section 6): when the alarm was last acknowledged (or sent), in UTC.
|
#
|
public
|
triggerTime(Occurrence $occurrence, ?DateTimeZone $timezone = null): ?DateTimeImmutable
When the alarm of the occurrence goes off.
When the alarm of the occurrence goes off.
|
#
|
public
|
description(): ?string
|
#
|
public
|
summary(): ?string
|
#
|
public
|
repeat(): int
REPEAT: number of additional repetitions.
REPEAT: number of additional repetitions.
|
#
|
public
|
duration(): ?DateInterval
DURATION: delay between repetitions.
DURATION: delay between repetitions.
|
#
|
public
|
attendees(): list<CalAddress>
|
#
|