1Data::ICal::Entry::AlarUms:e:rDiCsopnltaryi(b3u)ted PerlDaDtoac:u:mIeCnatla:t:iEonntry::Alarm::Display(3)
2
3
4

NAME

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

SYNOPSIS

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

DESCRIPTION

20       A Data::ICal::Entry::Alarm::Display object represents a alarm that
21       displays a message which is attached to a todo item or event in an
22       iCalendar file.  (Note that the iCalendar RFC refers to entries as
23       "components".)  It is a subclass of Data::ICal::Entry and accepts all
24       of its methods.
25

METHODS

27   new
28       Creates a new Data::ICal::Entry::Alarm::Display object; sets its
29       "ACTION" property to "DISPLAY".
30
31   ical_entry_type
32       Returns "VALARM", its iCalendar entry name.
33
34   optional_unique_properties
35       According to the iCalendar standard, the "duration" and "retreat"
36       properties may be specified at most one time for an displayed alarm,
37       and if one is specified, the other one must be also, though this module
38       does not enforce that restriction.
39
40   mandatory_unique_properties
41       According to the iCalendar standard, the "trigger" and "description"
42       properties must be specified exactly once for an displayed alarm.  (In
43       addition, the "action" property must be specified exactly once, but the
44       module automatically sets it for you.)
45

AUTHOR

47       Jesse Vincent "<jesse@bestpractical.com>" with David Glasser, Simon
48       Wistow, and Alex Vandiver
49

51       Copyright (c) 2005 - 2009, Best Practical Solutions, LLC.  All rights
52       reserved.
53
54       This module is free software; you can redistribute it and/or modify it
55       under the same terms as Perl itself. See perlartistic.
56

DISCLAIMER OF WARRANTY

58       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
59       FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
60       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
61       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
62       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
63       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
64       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
65       YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
66       NECESSARY SERVICING, REPAIR, OR CORRECTION.
67
68       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
69       WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
70       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
71       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
72       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
73       SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
74       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
75       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
76       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
77       DAMAGES.
78
79
80
81perl v5.12.0                      2009-07-1D0ata::ICal::Entry::Alarm::Display(3)
Impressum