module RiCal::Properties::Alarm
-
©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
Public Instance Methods
return the value of the ACTION property which will be an instance of String
# File lib/ri_cal/properties/alarm.rb, line 34 def action action_property ? action_property.ruby_value : nil end
set the value of the ACTION property
# File lib/ri_cal/properties/alarm.rb, line 28 def action=(ruby_value) self.action_property= RiCal::PropertyValue::Text.convert(self, ruby_value) end
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
# File lib/ri_cal/properties/alarm.rb, line 17 def action_property @action_property end
set the ACTION property property value should be an instance of RiCal::PropertyValueText
# File lib/ri_cal/properties/alarm.rb, line 23 def action_property=(property_value) @action_property = property_value end
add one value to the ATTACH property one instances of Uri may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 308 def add_attach(ruby_value) self.attach_property << RiCal::PropertyValue::Uri.convert(self, ruby_value) end
add one or more values to the ATTACH property one or more instances of Uri may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 302 def add_attachments(*ruby_values) ruby_values.each {|val| self.attach_property << RiCal::PropertyValue::Uri.convert(self, val)} end
add one value to the ATTENDEE property one instances of CalAddress may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 245 def add_attendee(ruby_value) self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, ruby_value) end
add one or more values to the ATTENDEE property one or more instances of CalAddress may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 239 def add_attendees(*ruby_values) ruby_values.each {|val| self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, val)} end
return the value of the ATTACH property which will be an array of instances of Uri
# File lib/ri_cal/properties/alarm.rb, line 326 def attach attach_property.map {|prop| prop ? prop.ruby_value : prop} end
set the value of the ATTACH property to a single value one instance of Uri may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 296 def attach=(ruby_value) @attach_property = [RiCal::PropertyValue::Uri.convert(self, ruby_value)] end
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
# File lib/ri_cal/properties/alarm.rb, line 278 def attach_property @attach_property ||= [] end
set the the ATTACH property one or more instances of RiCal::PropertyValueUri may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 284 def attach_property=(*property_values) @attach_property= property_values end
set the value of the ATTACH property to multiple values one or more instances of Uri may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 290 def attachments=(ruby_values) @attach_property = ruby_values.map {|val| RiCal::PropertyValue::Uri.convert(self, val)} end
return the value of the ATTENDEE property which will be an array of instances of CalAddress
# File lib/ri_cal/properties/alarm.rb, line 263 def attendee attendee_property.map {|prop| prop ? prop.ruby_value : prop} end
set the value of the ATTENDEE property to a single value one instance of CalAddress may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 233 def attendee=(ruby_value) @attendee_property = [RiCal::PropertyValue::CalAddress.convert(self, ruby_value)] end
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
# File lib/ri_cal/properties/alarm.rb, line 215 def attendee_property @attendee_property ||= [] end
set the the ATTENDEE property one or more instances of RiCal::PropertyValueCalAddress may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 221 def attendee_property=(*property_values) @attendee_property= property_values end
set the value of the ATTENDEE property to multiple values one or more instances of CalAddress may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 227 def attendees=(ruby_values) @attendee_property = ruby_values.map {|val| RiCal::PropertyValue::CalAddress.convert(self, val)} end
return the value of the DESCRIPTION property which will be an instance of String
# File lib/ri_cal/properties/alarm.rb, line 67 def description description_property ? description_property.ruby_value : nil end
set the value of the DESCRIPTION property
# File lib/ri_cal/properties/alarm.rb, line 61 def description=(ruby_value) self.description_property= RiCal::PropertyValue::Text.convert(self, ruby_value) end
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
# File lib/ri_cal/properties/alarm.rb, line 50 def description_property @description_property end
set the DESCRIPTION property property value should be an instance of RiCal::PropertyValueText
# File lib/ri_cal/properties/alarm.rb, line 56 def description_property=(property_value) @description_property = property_value end
return the value of the DURATION property which will be an instance of Duration
# File lib/ri_cal/properties/alarm.rb, line 133 def duration duration_property ? duration_property.ruby_value : nil end
set the value of the DURATION property
# File lib/ri_cal/properties/alarm.rb, line 127 def duration=(ruby_value) self.duration_property= RiCal::PropertyValue::Duration.convert(self, ruby_value) end
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
# File lib/ri_cal/properties/alarm.rb, line 116 def duration_property @duration_property end
set the DURATION property property value should be an instance of RiCal::PropertyValueDuration
# File lib/ri_cal/properties/alarm.rb, line 122 def duration_property=(property_value) @duration_property = property_value end
remove one value from the ATTACH property one instances of Uri may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 320 def remove_attach(ruby_value) self.attach_property.delete(RiCal::PropertyValue::Uri.convert(self, ruby_value)) end
remove one or more values from the ATTACH property one or more instances of Uri may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 314 def remove_attachments(*ruby_values) ruby_values.each {|val| self.attach_property.delete(RiCal::PropertyValue::Uri.convert(self, val))} end
remove one value from the ATTENDEE property one instances of CalAddress may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 257 def remove_attendee(ruby_value) self.attendee_property.delete(RiCal::PropertyValue::CalAddress.convert(self, ruby_value)) end
remove one or more values from the ATTENDEE property one or more instances of CalAddress may be passed to this method
# File lib/ri_cal/properties/alarm.rb, line 251 def remove_attendees(*ruby_values) ruby_values.each {|val| self.attendee_property.delete(RiCal::PropertyValue::CalAddress.convert(self, val))} end
return the value of the REPEAT property which will be an instance of Integer
# File lib/ri_cal/properties/alarm.rb, line 166 def repeat repeat_property ? repeat_property.ruby_value : nil end
set the value of the REPEAT property
# File lib/ri_cal/properties/alarm.rb, line 160 def repeat=(ruby_value) self.repeat_property= RiCal::PropertyValue::Integer.convert(self, ruby_value) end
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
# File lib/ri_cal/properties/alarm.rb, line 149 def repeat_property @repeat_property end
set the REPEAT property property value should be an instance of RiCal::PropertyValueInteger
# File lib/ri_cal/properties/alarm.rb, line 155 def repeat_property=(property_value) @repeat_property = property_value end
return the value of the SUMMARY property which will be an instance of String
# File lib/ri_cal/properties/alarm.rb, line 199 def summary summary_property ? summary_property.ruby_value : nil end
set the value of the SUMMARY property
# File lib/ri_cal/properties/alarm.rb, line 193 def summary=(ruby_value) self.summary_property= RiCal::PropertyValue::Text.convert(self, ruby_value) end
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
# File lib/ri_cal/properties/alarm.rb, line 182 def summary_property @summary_property end
set the SUMMARY property property value should be an instance of RiCal::PropertyValueText
# File lib/ri_cal/properties/alarm.rb, line 188 def summary_property=(property_value) @summary_property = property_value end
return the value of the TRIGGER property which will be an instance of Duration
# File lib/ri_cal/properties/alarm.rb, line 100 def trigger trigger_property ? trigger_property.ruby_value : nil end
set the value of the TRIGGER property
# File lib/ri_cal/properties/alarm.rb, line 94 def trigger=(ruby_value) self.trigger_property= RiCal::PropertyValue::Duration.convert(self, ruby_value) end
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
# File lib/ri_cal/properties/alarm.rb, line 83 def trigger_property @trigger_property end
set the TRIGGER property property value should be an instance of RiCal::PropertyValueDuration
# File lib/ri_cal/properties/alarm.rb, line 89 def trigger_property=(property_value) @trigger_property = property_value end