NAME¶
Data::ICal::Entry::Event - Represents an event in an iCalendar file
SYNOPSIS¶
my $vevent = Data::ICal::Entry::Event->new();
$vevent->add_properties(
summary => "my party",
description => "I'll cry if I want to",
# Dat*e*::ICal is not a typo here
dtstart => Date::ICal->new( epoch => time )->ical,
);
$calendar->add_entry($vevent);
$vevent->add_entry($alarm);
DESCRIPTION¶
A Data::ICal::Entry::Event object represents a single 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¶
ical_entry_type¶
Returns "VEVENT", its iCalendar entry name.
optional_unique_properties¶
According to the iCalendar standard, the following properties may be specified
at most one time for an event:
class created description dtstart geo
last-modified location organizer priority
dtstamp sequence status summary transp
uid url recurrence-id
In addition, "dtend" 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 dtend
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 an event:
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
SEE ALSO¶
- Data::ICal::DateTime
- For date parsing and formatting, including denoting "all day"
events, considering using this module. Because it's a "mix in",
you can still use all the methods here as well as the new date handling
methods it defines.
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.