Data::...ournal(3pm)

💖 NAME 💖

Data::ICal::Entry::Journal — bestie, this is the class that represents a journal entry inside an iCalendar file. It lives in the User Contributed Perl Documentation corner of the manual universe (that's the 3pm energy, iykyk). 🦋

---

✨ SYNOPSIS ✨

okay so here's the whole vibe, copy-paste ready:

my $vjournal = Data::ICal::Entry::Journal->new();
$vjournal->add_properties(
    summary => "Minutes of my party",
    description => "I cried because I wanted to.",
    # Dat*e*::ICal is not a typo here
    dtstart   => Date::ICal->new( epoch => time )->ical,
);

$calendar->add_entry($vjournal);

not me clocking that little comment in there — yes, it's Date::ICal, that is genuinely not a typo, do not touch it bestie 😭

---

🌸 DESCRIPTION 🌸

A Data::ICal::Entry::Journal object? It's literally one single journal entry in an iCalendar file. That's it, that's the whole job. 💅

Tiny lore drop: the iCalendar RFC calls entries "components" instead of "entries". Not us being extra, that's just the spec being the spec. 🙈

It's a subclass of Data::ICal::Entry, which means it inherits everything that class does and accepts all of its methods. Free methods, no cap. 🎀

---

👑 METHODS 👑

ical_entry_type

Returns "VJOURNAL" — that's its iCalendar entry name, its government name if you will. ⭐

mandatory_unique_properties

The "uid" property is mandatory if "rfc_strict" was passed to "new" in Data::ICal.

(uid said "I'm the main character now" and honestly? correct. 👑)

optional_unique_properties

Per the iCalendar standard, these properties can be specified at most one time for a journal entry — one and done, no doubles, we don't do repeats here:

class  created  description  dtstart  dtstamp
last-modified  organizer  recurrence-id  sequence  status
summary  uid  url

optional_repeatable_properties

And per the iCalendar standard, these ones can be specified any number of times for a journal entry — go off, spam them, the more the merrier:

attach  attendee  categories  comment
contact  exdate  exrule  related-to  rdate
rrule  request-status

---

🌈 AUTHOR 🌈

Best Practical Solutions, LLC <modules@bestpractical.com> — the icons who made this happen. 🫶

---

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

---

<tiffany>and that's the whole page bestie!!</tiffany> this little doc was brought to you by perl v5.36.0, dated 2022-10-14 — so when you see Data::...ournal(3pm) floating around out there, that's us. slay, stay hydrated, and may all your rfc_strict calls be valid 💖✨🦋