/ 
Net-ICal-0.13
River stage zero No dependents
/ Net::ICal::Alarm

NAME

Net::ICal::Alarm -- represent a VALARM

SYNOPSIS

use Net::ICal; # simple syntax $a = new Net::ICal::Alarm(action => 'DISPLAY', trigger => "20000101T073000", description => "Wake Up!");

# elaborate $a = new Net::ICal::Alarm (action => 'EMAIL', trigger => new Net::ICal::Trigger ( type => 'DURATION', content => new Net::ICal::Duration ("-PT5M"), related => 'END'), attendee => [new Net::ICal::Attendee ("mailto:alice\@wonderland.com")], summary => "mail subject", description => "mail contents");

DESCRIPTION

This class handles reminders for Net::ICal Events and Todos. You can get a reminder in several different ways (a sound played, a message displayed on your screen, an email or a script/application run for you) at a certain time, either relative to the Event or Todo the Alarm is part of, or at a fixed date/time

CONSTRUCTOR

new (optionhash)

Create a new Alarm. The minimum options are an action, a trigger and either an attach or a description.

The action describes what type of Alarm this is going to be. See "alarm" below for possible options. The trigger describes when the alarm will be triggered. See "trigger" below for an explanation.

METHODS

action The action can be:

  • AUDIO - play an audio file. Requires an "attach" property (a soundfile).

  • DISPLAY - pop up a note on the screen. Requires a "description" containing the text of the note.

  • EMAIL - send an email. Requires a "description" containing the email body and one or more "attendee"s for the email address(es).

  • PROCEDURE - trigger a procedure described by an "attach" which is the command to execute (required).

trigger

The time at which to fire of the reminder. This can either be relative to the Event/Todo (a Net::ICal::Duration or at a fixed date/time (a Net::ICal::Time)

summary

If the Alarm has an EMAIL "action" then the text of the summary string will be the Subject header of the email.

description

If the Alarm has an EMAIL "action" then the text of the description string will be the body of the email. If it's a PROCEDURE, this is the argument string to be passed to the program

attach

If the Alarm is an AUDIO alarm, this contains the sound to be played, either as an URL or inline. If the Alarm has "action" EMAIL, this will be attached to the email. Finally, if it is a PROCEDURE Alarm, it contains the application to be executed.

attendee

This contains one or more Net::ICal::Attendee objects that describe the email addresses of the people that need to receive this Alarm. This is only valid for EMAIL Alarms of course.

repeat

The number of times the Alarm must be repeated. If you specify this, you must also specify "duration"

duration

The time before the Alarm is repeated. This is a Net::ICal::Duration object.