Data::...:Event(3pm)

👑 Data::ICal::Entry::Event — the perl manpage but make it cute

okay so bestie, this is from User Contributed Perl Documentation, and it's literally the page for Data::ICal::Entry::Event. yes the section is called NAME, we're keeping it, but let me tell you what it is: it's the thing that represents an event in an iCalendar file. periodt. 💖

---

🌸 NAME 🌸

Data::ICal::Entry::Event — Represents an event in an iCalendar file

---

✨ SYNOPSIS ✨

here's the vibe, copy-paste core:

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);

no cap, that last bit where you add_entry an alarm to a vevent? that's the whole energy of this module. nesting. iconic. 🎀

---

🦋 DESCRIPTION 🦋

A Data::ICal::Entry::Event object represents a single event in an iCalendar file. ok important lil note: the iCalendar RFC calls entries "components" — so if you see that word floating around, it's the same thing, don't panic. 🙈

It's a subclass of Data::ICal::Entry, which means it inherits and accepts all of its methods. everything the parent can do, your lil event can do too. lowkey nepotism but we support it. 💅

---

💜 METHODS 💜

🌟 ical_entry_type

Returns "VEVENT", its iCalendar entry name. that's it. that's the whole method. she's simple, she's reliable. ✨

🌟 mandatory_unique_properties

The uid property is mandatory if rfc_strict was passed to new in Data::ICal. so if you asked for strict mode, bestie, you must bring a uid. no uid, no entry. 😭

🌟 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 heads up, this restriction is not enforced. 🫠 like, the standard says no, but the code is out here letting you live your truth.

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. go off, stack them, she contains multitudes. 🔥

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. so you get this module's methods plus shiny new date methods. two for one, obsessed. 🫶

---

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

---

and that's the whole page bestie, you're now certified in VEVENT lore 👑

this lil tour was brought to you by perl v5.36.0, dated 2022-10-14, straight from the Data::...:Event(3pm) page. mwah 💋 stay hydrated and keep your uids unique ✨