Data::ICal::Entry::Alarm::Procedure 0.12

Data::ICal::Entry::Alarm::Procedure is a Perl module that represents a procedure-call alarm in an iCalendar file.

SYNOPSIS

my $valarm = Data::ICal::Entry::Alarm::Procedure->new();
$valarm->add_properties(
attach => [ "ftp://host.com/novo-procs/felizano.exe", { fmttype => "application/binary" } ],
# Dat*e*::ICal is not a typo here
trigger => [ Date::ICal->new( epoch => ... )->ical, { value => DATE-TIME } ],
);

$vevent->add_entry($valarm);

A Data::ICal::Entry::Alarm::Procedure object represents an alarm that calls a procedure (in some application-defined way), which is attached to a todo item or event in an iCalendar file. (Note that the iCalendar RFC refers to entries as "components".) It is a subclass of Data::ICal::Entry and accepts all of its methods.

METHODS

new

Creates a new Data::ICal::Entry::Alarm::Procedure object; sets its ACTION property to PROCEDURE.

ical_entry_type

Returns VALARM, its iCalendar entry name.

optional_unique_properties

According to the iCalendar standard, the following properties may be specified at most one time for a procedure-call alarm:

duration repeat description

Note that if one of duration or repeat is specified, the other one must be also, though this module does not enforce that restriction.

mandatory_unique_properties

According to the iCalendar standard, the trigger and attach properties must be specified exactly once for a procedure-call alarm. (In addition, the action property must be specified exactly once, but the module automatically sets it for you.)