Alex Vandiver > Data-ICal-0.22 > Data::ICal::Entry::Alarm

Download:
Data-ICal-0.22.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Source  

NAME ^

Data::ICal::Entry::Alarm - Abstract base class for alarms

DESCRIPTION ^

Data::ICal::Entry::Alarm is an abstract base class for the other type of supported by alarms:

Data::ICal::Entry::Alarm::Audio
Data::ICal::Entry::Alarm::Display
Data::ICal::Entry::Alarm::Email
Data::ICal::Entry::Alarm::Procedure

It is a subclass of Data::ICal::Entry and accepts all of its methods.

METHODS ^

new

ical_entry_type

Returns VALARM, its iCalendar entry name.

optional_unique_properties

According to the iCalendar standard, the duration and retreat properties may be specified at most one time all types of alarms; if one is specified, the other one must be also, though this module does not enforce that restriction.

mandatory_unique_properties

According to the iCalendar standard, the trigger property must be specified exactly once for an all types of alarms; subclasses may have additional required properties.

In addition, the action property must be specified exactly once, but all subclasses automatically set said property appropriately.

AUTHOR ^

Best Practical Solutions, LLC <modules@bestpractical.com>

LICENCE AND COPYRIGHT ^

Copyright (c) 2005 - 2015, 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.

syntax highlighting: