Scroll to navigation

Data::ICal::Entry::Journal(3pm) User Contributed Perl Documentation Data::ICal::Entry::Journal(3pm)

NAME

Data::ICal::Entry::Journal - Represents a journal entry in an iCalendar file

SYNOPSIS

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

DESCRIPTION

A Data::ICal::Entry::Journal object represents a single journal entry in an iCalendar file. (Note that the iCalendar RFC refers to entries as "components".) It is a subclass of Data::ICal::Entry and accepts all of its methods.

METHODS

ical_entry_type

Returns "VJOURNAL", its iCalendar entry name.

mandatory_unique_properties

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

optional_unique_properties

According to the iCalendar standard, the following properties may be specified at most one time for a journal entry:

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

optional_repeatable_properties

According to the iCalendar standard, the following properties may be specified any number of times for a journal entry:

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

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.

2020-01-06 perl v5.30.0