1Data::ICal::Entry::EvenUts(e3r)Contributed Perl DocumentDaattiao:n:ICal::Entry::Event(3)
2
3
4

NAME

6       Data::ICal::Entry::Event - Represents an event in an iCalendar file
7

SYNOPSIS

9           my $vevent = Data::ICal::Entry::Event->new();
10           $vevent->add_properties(
11               summary => "my party",
12               description => "I'll cry if I want to",
13               # Dat*e*::ICal is not a typo here
14               dtstart   => Date::ICal->new( epoch => time )->ical,
15           );
16
17           $calendar->add_entry($vevent);
18
19           $vevent->add_entry($alarm);
20

DESCRIPTION

22       A Data::ICal::Entry::Event object represents a single event in an
23       iCalendar file.  (Note that the iCalendar RFC refers to entries as
24       "components".)  It is a subclass of Data::ICal::Entry and accepts all
25       of its methods.
26

METHODS

28   ical_entry_type
29       Returns "VEVENT", its iCalendar entry name.
30
31   mandatory_unique_properties
32       The "uid" property is mandatory if "rfc_strict" was passed to "new" in
33       Data::ICal.
34
35   optional_unique_properties
36       According to the iCalendar standard, the following properties may be
37       specified at most one time for an event:
38
39               class  created  description  dtstart  geo
40               last-modified  location  organizer  priority
41               dtstamp  sequence  status  summary  transp
42               uid  url  recurrence-id
43
44       In addition, "dtend" and "duration" may be specified at most once each,
45       but not both in the same entry (though this restriction is not
46       enforced).
47
48       Or if "vcal10 => 1":
49
50               class dcreated completed description dtstart dtend
51               last-modified location rnum priority
52               sequence status summary transp
53               url uid
54
55   optional_repeatable_properties
56       According to the iCalendar standard, the following properties may be
57       specified any number of times for an event:
58
59               attach  attendee  categories  comment
60               contact  exdate  exrule  request-status  related-to
61               resources  rdate  rrule
62
63       Or if "vcal10 => 1":
64
65               aalarm  attach  attendee  categories
66               dalarm  exdate  exrule  malarm  palarm  related-to
67               resources  rdate  rrule
68

SEE ALSO

70       Data::ICal::DateTime
71           For date parsing and formatting, including denoting "all day"
72           events, considering using this module. Because it's a "mix in", you
73           can still use all the methods here as well as the new date handling
74           methods it defines.
75

AUTHOR

77       Best Practical Solutions, LLC <modules@bestpractical.com>
78

80       Copyright (c) 2005 - 2020, Best Practical Solutions, LLC.  All rights
81       reserved.
82
83       This module is free software; you can redistribute it and/or modify it
84       under the same terms as Perl itself. See perlartistic.
85
86
87
88perl v5.32.1                      2021-01-27       Data::ICal::Entry::Event(3)
Impressum