trusty (3) Data::ICal::Entry::Todo.3pm.gz

NAME

       Data::ICal::Entry::Todo - Represents a to-do entry in an iCalendar file

SYNOPSIS

           my $vtodo = Data::ICal::Entry::Todo->new();
           $vtodo->add_properties(
               summary   => "go to sleep",
               status    => 'INCOMPLETE',
               # Dat*e*::ICal is not a typo here
               dtstart   => Date::ICal->new( epoch => time )->ical,
           );

           $calendar->add_entry($vtodo);

           $vtodo->add_entry($alarm);

DESCRIPTION

       A Data::ICal::Entry::Todo object represents a single to-do entry 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

   ical_entry_type
       Returns "VTODO", its iCalendar entry name.

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

             class  completed  created  description  dtstamp
             dtstart  geo  last-modified  location  organizer
             percent-complete  priority  recurrence-id  sequence  status
             summary  uid  url

       In addition, "due" and "duration" may be specified at most once each, but not both in the same entry
       (though this restriction is not enforced).

       Or if "vcal10 => 1":

               class dcreated completed description dtstart due
               last-modified location rnum priority
               sequence status summary transp
               url uid

   optional_repeatable_properties
       According to the iCalendar standard, the following properties may be specified any number of times for a
       to-do item:

             attach  attendee  categories  comment  contact
             exdate  exrule  request-status  related-to  resources
             rdate  rrule

       Or if "vcal10 => 1":

               aalarm  attach  attendee  categories
               dalarm  exdate  exrule  malarm  palarm  related-to
               resources  rdate  rrule

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.