/ 
Net-ICal-0.15
River stage zero No dependents
++
/ Net::ICal::Todo

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

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

OPTIONAL

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

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

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

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

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

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

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

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

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

  • 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.

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

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

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

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

  • url - a URL for this Todo. Optional.

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

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

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

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

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

  • 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.

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

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

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

RECURRING TASKS

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

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

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

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

  • 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.