-
-
03 Jan 2020 14:27:46 UTC
- Distribution: Data-ICal
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (7)
- Testers (654 / 0 / 0)
- Kwalitee
Bus factor: 2- 91.75% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (117.63KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors-
Best Practical Solutions, LLC
- Dependencies
- Class::Accessor
- Class::ReturnValue
- MIME::QuotedPrint
- Text::vFile::asData
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
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.mandatory_unique_properties
The
uid
property is mandatory ifrfc_strict
was passed to "new" in Data::ICal.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
andduration
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
Best Practical Solutions, LLC <modules@bestpractical.com>
LICENCE AND COPYRIGHT
Copyright (c) 2005 - 2020, 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.
Module Install Instructions
To install Data::ICal, copy and paste the appropriate command in to your terminal.
cpanm Data::ICal
perl -MCPAN -e shell install Data::ICal
For more information on module installation, please visit the detailed CPAN module installation guide.