Net::ICal::Trigger -- represent the TRIGGER property for VALARMs


NAME

Net::ICal::Trigger -- represent the TRIGGER property for VALARMs


SYNOPSIS

  use Net::ICal;
  # 5 minutes after the end of the event or to-do
  # DURATION is the default type, so it's optional
  $t = new Net::ICal::Trigger (300);
  $t = new Net::ICal::Trigger (new Net::ICal::Duration ("PT5M"),
                               related => 'END');
  # trigger for 7:30am, Jan 1st 2000
  $t = new Net::ICal::Trigger (new Net::ICal::Time ('20000101T073000'));


DESCRIPTION

Triggers are time markers, used most commonly for Alarms. They're attached to Times or Durations.


CONSTRUCTORS

new


METHODS

value([$value])

Get or set the type of the trigger. Valid options are

DURATION
DATE-TIME

related ([$related])

Get or set the relation of this alarm to the Event or Todo it is related to. This is only used for alarms that are related to an Event or Todo component, and its value must be a Duration. Valid options are

START
The Duration is relative to the start of the Event or Todo's Period

END
The Duration is relative to the end of the Event or Todo's Period


SEE ALSO

the Net::ICal::Time manpage, the Net::ICal::Duration manpage, the Net::ICal::Alarm manpage.

More information can be found in the Net::ICal manpage.

 Net::ICal::Trigger -- represent the TRIGGER property for VALARMs