Index
- NAME
- SYNOPSIS
- DESCRIPTION
- BASIC METHODS
- new($args)
- REQUIRED
-
- * dtstart - a Net::ICal::Time for when this event starts.
- * dtend - a Net::ICal::Time for the end of this event. Use either this OR a duration (below). Use when the ending time of an event is fixed ("I have to leave at 3pm to pick up my child.")
- * duration - a Net::ICal::Duration; how long this event lasts. Use for things like plane flights - "The trip will take 2 hours, no matter when the plane takes off. If I start late, I end late." Use either this OR a dtend, above.
- * organizer - a Net::ICal::Attendee for who's organizing this meeting.
- OPTIONAL
-
- * 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 event.
- * contact - a string describing who to contact about this event.
- * request_status - how successful we've been at scheduling this event 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 Event is related to.
- * resources - resources (such as an overhead projector) required for this event.
- * sequence - an integer that starts at 0 when this object is created and is incremented every time the object is changed.
- RECURRING EVENTS
-
- * recurrence_id - if this event occurs multiple times, which occurrence of it is this particular event?
- * rdate - an array of Net::ICal::Time objects describing repeated occurrences of this event.
- * rrule - an array of Net::ICal::Recurrence objects telling when this event repeats.
- * exdate - a Net::ICal::Time giving a single-date exception to a recurring event.
- * exrule - an array of Net::ICal::Recurrence objects giving a recurring exception to a recurring event.
- SEE ALSO
Code Index:
NAME
Net::ICal::Event -- Event class
SYNOPSIS
use Net::ICal::Event;
my $e = new Net::ICal::Event (
organizer => new Net::ICal::Attendee('alice'),
uid => 'fooid',
alarms => [Net::ICal::Event objects],
dtstart => new Net::ICal::Time("20010207T160000Z"),
summary => 'tea with the white rabbit',
);
DESCRIPTION
Net::ICal::Event represents iCalendar events.
BASIC METHODS
new($args)
Construct a new Event. Parameters are in a hash. Meaningful parameters are:
REQUIRED
- * dtstart - a Net::ICal::Time for when this event starts.
- * dtend - a Net::ICal::Time for the end of this event. Use either this OR a duration (below). Use when the ending time of an event is fixed ("I have to leave at 3pm to pick up my child.")
- * duration - a Net::ICal::Duration; how long this event lasts. Use for things like plane flights - "The trip will take 2 hours, no matter when the plane takes off. If I start late, I end late." Use either this OR a dtend, above.
- * organizer - a Net::ICal::Attendee for who's organizing this meeting.
OPTIONAL
- * 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 event.
- * contact - a string describing who to contact about this event.
- * request_status - how successful we've been at scheduling this event 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.
- * resources - resources (such as an overhead projector) required for this event.
- * sequence - an integer that starts at 0 when this object is created and is incremented every time the object is changed.
RECURRING EVENTS
- * recurrence_id - if this event occurs multiple times, which occurrence of it is this particular event?
- * rdate - an array of Net::ICal::Time objects describing repeated occurrences of this event.
- * rrule - an array of Net::ICal::Recurrence objects telling when this event repeats.
- * exdate - a Net::ICal::Time giving a single-date exception to a recurring event.
- * exrule - an array of Net::ICal::Recurrence objects giving a recurring exception to a recurring event.
SEE ALSO
More documentation pointers can be found in Net::ICal.