Net::ICal::Todo(3p)   User Contributed Perl Documentation  Net::ICal::Todo(3p)



NAME
       Net::ICal::Todo -- Todo class

SYNOPSIS
         use Net::ICal::Todo;
         my $c = new Net::ICal::Todo();

DESCRIPTION
       Net::ICal::Todo represents something someone needs to get done.

BASIC METHODS
   new($args)
       Construct a new Todo. Parameters are in a hash.  Meaningful parameters
       are:

   REQUIRED
       o   organizer - a Net::ICal::Attendee for who's organizing this
           meeting.

   OPTIONAL
       o   dtstart - a Net::ICal::Time for when this Todo starts.

       o   duration - a Net::ICal::Duration; how long this thing will take to
           do.

       o   alarms - an array of Net::ICal::Alarm objects; reminders about
           doing this item.

       o   class - PUBLIC, PRIVATE, or CONFIDENTIAL - the creator's intention
           about who should see this Todo.

       o   created - a Net::ICal::Time saying when this object was created.

       o   description - a hash with at least a content key, maybe an altrep
           and a language key. Content is a description of this Todo.

       o   dtstamp - when this Todo was created. Will be set to the current
           time unless otherwise specified.

       o   geo - a pair of real numbers--- the latitude and longitude of this
           Todo.

       o   last_modified - a Net::ICal::Time specifying the last time this
           object was changed.

       o   location - a hash for where this Todo is taking place. The content
           key points to a string about the location; the altrep key gives an
           alternate representation, for example a URL.

       o   priority - a number from 0 (undefined) to 1 (highest) to 9 (lowest)
           representing how important this event is.

       o   status - NEEDS-ACTION, IN-PROGRESS, COMPLETED, or CANCELLED; the
           status of this todo item.

       o   summary - a one-line summary of this Todo. If you need more space,
           use the description parameter.

       o   uid - a globally unique identifier for this event. Will be created
           automagically.

       o   url - a URL for this Todo. Optional.

       o   attach - a Net::ICal::Attach - attached file for this Todo.

       o   attendee - who's going to be at this meeting; an array of
           Net::ICal::Attendee objects.

       o   categories - what categories this event falls into. Make up your
           own categories. Optional.

       o   comment - a hash like that for description (above), comments on
           this Todo item.

       o   contact - a string describing who to contact about this Todo.

       o   request_status - how successful we've been at scheduling this Todo
           so far. Values can be integers separated by periods. 1.x.y is a
           preliminary success, 2.x.y is a complete successful request, 3.x.y
           is a failed request because of bad iCal format, 4.x.y is a calendar
           server failure.

       o   related_to - an array of other Event, Todo, or Journal objects this
           Todo is related to.

       o   resources - resources (such as an overhead projector) required for
           doing this task.

       o   sequence - an integer that starts at 0 when this object is created
           and is incremented every time the object is changed.

   RECURRING TASKS
       o   recurrence_id - if this task occurs multiple times, which
           occurrence of it is this particular task?

       o   rdate - an array of Net::ICal::Time objects describing repeated
           occurrences of this task.

       o   rrule - an array of Net::ICal::Recurrence objects telling when this
           task repeats.

       o   exdate - a Net::ICal::Time giving a single-date exception to a
           recurring task.

       o   exrule - an array of  Net::ICal::Recurrence objects giving a
           recurring exception to a recurring task.

   $class->validate
       Validates the properties of a Todo.  Returns 1 for success, undef for
       failure.

       TODO: make sure that this object has the bare minimum requirements
       specified by the RFC.

DEVELOPER METHODS
       The following methods are probably not of interest to you unless you
       are a Reefknot developer.

   $c->_create(%args)
       Class::MethodMapper creation routine.

SEE ALSO
       More documentation pointers can be found in Net::ICal.



perl v5.12.2                      2001-07-09               Net::ICal::Todo(3p)
