Data::...Display(3pm)

💖 Data::ICal::Entry::Alarm::Display — bestie edition 💖

okay so this is the manual page for Data::ICal::Entry::Alarm::Display(3pm), living in the User Contributed Perl Documentation corner of the universe. it's the class that represents a displayed alarm in an iCalendar file. yes, that kind of alarm. the "hey bestie look at this" kind. ✨

---

🌸 NAME 🌸

Data::ICal::Entry::Alarm::Display — Represents a displayed alarm in an iCalendar file. that's the whole vibe. 👑

---

🎀 SYNOPSIS 🎀

like, here's how you actually use it:

my $valarm = Data::ICal::Entry::Alarm::Display->new();
$valarm->add_properties(
    description => "Wake up!",
    # Dat*e*::ICal is not a typo here
    trigger   => [ Date::ICal->new( epoch => ... )->ical, { value => 'DATE-TIME' } ],
);

$vevent->add_entry($valarm);

and yes, that comment is staying exactly where it is — Dat*e*::ICal is not a typo, it's genuinely a different module from Data::ICal and the module authors said what they said. iykyk 🫶

---

🦋 DESCRIPTION 🦋

so a Data::ICal::Entry::Alarm::Display object represents an alarm that displays a message, and that message is attached to a todo item or an event inside an iCalendar file. it's giving "pop-up reminder but make it standards-compliant." 💅

quick note bestie: the iCalendar RFC doesn't say "entries", it says "components". same thing, different name. don't let that jump-scare you. 🙈

this class is a subclass of Data::ICal::Entry::Alarm, and it accepts all of its methods. inherited everything, no cap. ✨

---

🔥 METHODS 🔥

💜 new

Creates a new Data::ICal::Entry::Alarm::Display object; sets its "ACTION" property to "DISPLAY". cute right? one line, one job, iconic. 👑

💜 mandatory_unique_properties

In addition to "action" and "trigger" (see "mandatory_unique_properties" in Data::ICal::Entry::Alarm), displayed alarms must also specify a value for "description".

so like — action? mandatory. trigger? mandatory. description? also mandatory, don't skip it, the alarm literally has nothing to say without it. 😭

---

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

---

okay bye bestie, go set some alarms 💖 this was perl v5.36.0, documented 2022-10-14, and it's filed under Data::...Display(3pm) — slay, ate, no crumbs left. 🎀✨🦋