logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Data::ICal::Entry::Alarm::Display - Represents a displayed alarm in an iCalendar file

Author

       Best Practical Solutions, LLC <modules@bestpractical.com>

Description

       A Data::ICal::Entry::Alarm::Display object represents a alarm that displays a message 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::Alarm and accepts all of its methods.

Methods

new
       Creates a new Data::ICal::Entry::Alarm::Display object; sets its "ACTION" property to "DISPLAY".

   mandatory_unique_properties
       In addition to "action" and "trigger" (see "mandatory_unique_properties" in Data::ICal::Entry::Alarm),
       displayed alarms must also specify a value for "description".

Name

       Data::ICal::Entry::Alarm::Display - Represents a displayed alarm in an iCalendar file

Synopsis

           my $valarm = Data::ICal::Entry::Alarm::Display->new();
           $valarm->add_properties(
               description => "Wake up!",
               # Dat*e*::ICal is not a typo here
               trigger   => [ Date::ICal->new( epoch => ... )->ical, { value => 'DATE-TIME' } ],
           );

           $vevent->add_entry($valarm);

See Also