1Data::ICal::Entry::AlarUms:e:rAuCdoinot(r3i)buted Perl DDoactuam:e:nItCaatli:o:nEntry::Alarm::Audio(3)
2
3
4

NAME

6       Data::ICal::Entry::Alarm::Audio - Represents an audio alarm in an
7       iCalendar file
8

SYNOPSIS

10           my $valarm = Data::ICal::Entry::Alarm::Audio->new();
11           $valarm->add_properties(
12               attach => [ "ftp://host.com/pub/sounds/bell-01.aud", { fmttype => "audio/basic" } ],
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::Audio object represents an audio alarm
21       attached to a todo item or event in an iCalendar file.  (Note that the
22       iCalendar RFC refers to entries as "components".)  It is a subclass of
23       Data::ICal::Entry and accepts all of its methods.
24

METHODS

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

AUTHOR

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

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

DISCLAIMER OF WARRANTY

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