Alex Vandiver > Data-ICal-0.22 > Data::ICal::Entry::Alarm::Display

Download:
Data-ICal-0.22.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Source  

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);

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.

AUTHOR ^

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

LICENCE AND COPYRIGHT ^

Copyright (c) 2005 - 2015, Best Practical Solutions, LLC. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

syntax highlighting: