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


Data-ICal documentation Contained in the Data-ICal distribution.

Index


Code Index:

NAME

Top

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

SYNOPSIS

Top

    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

Top

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

Top

ical_entry_type

Returns VJOURNAL, its iCalendar entry name.

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

Top

Jesse Vincent <jesse@bestpractical.com> with David Glasser, Simon Wistow, and Alex Vandiver

LICENCE AND COPYRIGHT

Top

DISCLAIMER OF WARRANTY

Top

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.


Data-ICal documentation Contained in the Data-ICal distribution.
use warnings;
use strict;

package Data::ICal::Entry::Journal;

use base qw/Data::ICal::Entry/;

sub ical_entry_type {'VJOURNAL'}

sub optional_unique_properties {
    qw(
        class  created  description  dtstart  dtstamp
        last-modified  organizer  recurrence-id  sequence  status
        summary  uid  url
    );
}

sub optional_repeatable_properties {
    qw(
        attach  attendee  categories  comment
        contact  exdate  exrule  related-to  rdate
        rrule  request-status
    );
}

1;