Module RiCal::Properties::Alarm
In: lib/ri_cal/properties/alarm.rb
  • ©2009 Rick DeNatale
  • All rights reserved. Refer to the file README.txt for the license
 Properties::Alarm provides property accessing methods for the Alarm class
 This source file is generated by the  rical:gen_propmodules rake tasks, DO NOT EDIT

Methods

Public Instance methods

return the value of the ACTION property which will be an instance of String

set the value of the ACTION property

return the the ACTION property which will be an instances of RiCal::PropertyValueText

[purpose (from RFC 2445)] This property defines the action to be invoked when an alarm is triggered

see RFC 2445 4.8.6.1 p 126

set the ACTION property property value should be an instance of RiCal::PropertyValueText

add one value to the ATTACH property one instances of Uri may be passed to this method

add one or more values to the ATTACH property one or more instances of Uri may be passed to this method

add one value to the ATTENDEE property one instances of CalAddress may be passed to this method

add one or more values to the ATTENDEE property one or more instances of CalAddress may be passed to this method

return the value of the ATTACH property which will be an array of instances of Uri

set the value of the ATTACH property to a single value one instance of Uri may be passed to this method

return the the ATTACH property which will be an array of instances of RiCal::PropertyValueUri

[purpose (from RFC 2445)] The property provides the capability to associate a document object with a calendar component.

see RFC 2445 4.8.1.1 pp 77-78

set the the ATTACH property one or more instances of RiCal::PropertyValueUri may be passed to this method

set the value of the ATTACH property to multiple values one or more instances of Uri may be passed to this method

return the value of the ATTENDEE property which will be an array of instances of CalAddress

set the value of the ATTENDEE property to a single value one instance of CalAddress may be passed to this method

return the the ATTENDEE property which will be an array of instances of RiCal::PropertyValueCalAddress

[purpose (from RFC 2445)] The property defines an ‘Attendee’ within a calendar component.

see RFC 2445 4.8.4.1 pp 102-104

set the the ATTENDEE property one or more instances of RiCal::PropertyValueCalAddress may be passed to this method

set the value of the ATTENDEE property to multiple values one or more instances of CalAddress may be passed to this method

return the value of the DESCRIPTION property which will be an instance of String

set the value of the DESCRIPTION property

return the the DESCRIPTION property which will be an instances of RiCal::PropertyValueText

[purpose (from RFC 2445)] This property provides a more complete description of the calendar component, than that provided by the "SUMMARY" property.

see RFC 2445 4.8.1.5 pp 81-82

set the DESCRIPTION property property value should be an instance of RiCal::PropertyValueText

return the value of the DURATION property which will be an instance of Duration

set the value of the DURATION property

return the the DURATION property which will be an instances of RiCal::PropertyValueDuration

[purpose (from RFC 2445)] This property specifies a positive duration of time.

see RFC 2445 4.8.2.5 pp 94-95

set the DURATION property property value should be an instance of RiCal::PropertyValueDuration

remove one value from the ATTACH property one instances of Uri may be passed to this method

remove one or more values from the ATTACH property one or more instances of Uri may be passed to this method

remove one value from the ATTENDEE property one instances of CalAddress may be passed to this method

remove one or more values from the ATTENDEE property one or more instances of CalAddress may be passed to this method

return the value of the REPEAT property which will be an instance of Integer

set the value of the REPEAT property

return the the REPEAT property which will be an instances of RiCal::PropertyValueInteger

[purpose (from RFC 2445)] This property defines the number of times the alarm should be repeated, after the initial trigger.

see RFC 2445 4.8.6.2 p 126-127

set the REPEAT property property value should be an instance of RiCal::PropertyValueInteger

return the value of the SUMMARY property which will be an instance of String

set the value of the SUMMARY property

return the the SUMMARY property which will be an instances of RiCal::PropertyValueText

[purpose (from RFC 2445)] This property defines a short summary or subject for the calendar component.

see RFC 2445 4.8.1.12 pp 89-90

set the SUMMARY property property value should be an instance of RiCal::PropertyValueText

return the value of the TRIGGER property which will be an instance of Duration

set the value of the TRIGGER property

return the the TRIGGER property which will be an instances of RiCal::PropertyValueDuration

[purpose (from RFC 2445)] This property specifies when an alarm will trigger.

see RFC 2445 4.8.6.3 p 127-129

set the TRIGGER property property value should be an instance of RiCal::PropertyValueDuration

[Validate]