Data::...ocedure(3pm)

💖 Data::ICal::Entry::Alarm::Procedure — the manual page, bestie edition 💖

okay so this is Data::ICal::Entry::Alarm::Procedure(3pm) from User Contributed Perl Documentation, and it's genuinely one of my faves so let's get into it 🫶

✨ NAME ✨

Data::ICal::Entry::Alarm::Procedure — it's the thing that represents a procedure-call alarm in an iCalendar file. yes that's the whole job. iconic behaviour honestly 👑

✨ SYNOPSIS ✨

okay watch how easy this is:

my $valarm = Data::ICal::Entry::Alarm::Procedure->new();
$valarm->add_properties(
    attach => [ "ftp://host.com/novo-procs/felizano.exe", { fmttype => "application/binary" } ],
    # Dat*e*::ICal is not a typo here
    trigger   => [ Date::ICal->new( epoch => ... )->ical, { value => 'DATE-TIME' } ],
);

$vevent->add_entry($valarm);

⚠️ note the comment ok: Date::ICal is not a typo here. it really do be spelled with an e in that one spot and i need you to not "fix" it, i'm begging 🙈

✨ DESCRIPTION ✨

so a Data::ICal::Entry::Alarm::Procedure object is like… an alarm that calls a procedure (in some application-defined way, so it's giving mystery ✨), and that procedure is attached to a todo item or an event inside an iCalendar file. that's the vibe 💅

quick heads up bestie: the iCalendar RFC calls entries "components". so when the RFC says component, it means entry. don't let that jump-scare you, it's the same thing 🎀

it is a subclass of Data::ICal::Entry::Alarm and it accepts all of its methods. inherited and thriving fr fr 💜

✨ METHODS ✨

🌸 new

creates a brand new Data::ICal::Entry::Alarm::Procedure object, and sets its "ACTION" property to "PROCEDURE". that's it, that's the method, she's efficient 🦋

🌸 optional_unique_properties

in addition to "duration" and "repeat" (hiiiii check "optional_unique_properties" in Data::ICal::Entry::Alarm), procedure-call alarms may also specify a value for "description". so there's room to add a lil description if you want 👑 optional = your call, no pressure.

🌸 mandatory_unique_properties

in addition to "action" and "trigger" (and yes, go look at "mandatory_unique_properties" in Data::ICal::Entry::Alarm), procedure-call alarms must also specify a value for "attach". must. mandatory. non-negotiable. not me stressing the word "must" but like… must 😭

✨ 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, no notes 💖 this was Data::...ocedure rendered from perl v5.36.0, dated 2022-10-14 — slay, periodt ✨🌸💅