trusty (3) Data::ICal::Entry::Alarm::Procedure.3pm.gz

NAME

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

SYNOPSIS

           my $valarm = Data::ICal::Entry::Alarm::Procedure->new();
           $valarm->add_properties(
               attach => [ "ftp://host.com/novo-procs/felizano.exe", { fmttype => "application/binary" } ],
               # 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::Procedure object represents an alarm that calls a procedure (in some
       application-defined way), 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 and accepts all
       of its methods.

METHODS

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

   ical_entry_type
       Returns "VALARM", its iCalendar entry name.

   optional_unique_properties
       According to the iCalendar standard, the following properties may be specified at most one time for a
       procedure-call alarm:

               duration repeat description

       Note that if one of "duration" or "repeat" is specified, the other one must be also, though this module
       does not enforce that restriction.

   mandatory_unique_properties
       According to the iCalendar standard, the "trigger" and "attach" properties must be specified exactly once
       for a procedure-call alarm.  (In addition, the "action" property must be specified exactly once, but the
       module automatically sets it for you.)

AUTHOR

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

LICENCE AND COPYRIGHT

       Copyright (c) 2005 - 2009, 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.

DISCLAIMER OF WARRANTY

       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT
       PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
       INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
       PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE
       SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY
       OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
       THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE
       WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGES.