1Data::ICal::Entry::AlarUms:e:rPrCoocnetdruirbeu(t3e)d PeDraltaD:o:cIuCmaeln:t:aEtnitorny::Alarm::Procedure(3)
2
3
4

NAME

6       Data::ICal::Entry::Alarm::Procedure - Represents a procedure-call alarm
7       in an iCalendar file
8

SYNOPSIS

10           my $valarm = Data::ICal::Entry::Alarm::Procedure->new();
11           $valarm->add_properties(
12               attach => [ "ftp://host.com/novo-procs/felizano.exe", { fmttype => "application/binary" } ],
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::Procedure object represents an alarm that
21       calls a procedure (in some application-defined way), which is attached
22       to a todo item or event in an iCalendar file.  (Note that the iCalendar
23       RFC refers to entries as "components".)  It is a subclass of
24       Data::ICal::Entry and accepts all of its methods.
25

METHODS

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

AUTHOR

50       Jesse Vincent "<jesse@bestpractical.com>" with David Glasser, Simon
51       Wistow, and Alex Vandiver
52

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

DISCLAIMER OF WARRANTY

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