©2009 Rick DeNatale
All rights reserved. Refer to the file README.txt for the license
Properties::Event provides property accessing methods for the Event class This source file is generated by the rical:gen_propmodules rake tasks, DO NOT EDIT
add one value to the ATTACH property one instances of Uri may be passed to this method
# File lib/ri_cal/properties/event.rb, line 676 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/event.rb, line 670 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/event.rb, line 739 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/event.rb, line 733 def add_attendees(*ruby_values) ruby_values.each {|val| self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, val)} end
add one value to the CATEGORIES property one instances of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 802 def add_categories(ruby_value) self.categories_property << RiCal::PropertyValue::Array.convert(self, ruby_value) end
add one value to the COMMENT property one instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 865 def add_comment(ruby_value) self.comment_property << RiCal::PropertyValue::Text.convert(self, ruby_value) end
add one or more values to the COMMENT property one or more instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 859 def add_comments(*ruby_values) ruby_values.each {|val| self.comment_property << RiCal::PropertyValue::Text.convert(self, val)} end
add one value to the CONTACT property one instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 928 def add_contact(ruby_value) self.contact_property << RiCal::PropertyValue::Text.convert(self, ruby_value) end
add one or more values to the CONTACT property one or more instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 922 def add_contacts(*ruby_values) ruby_values.each {|val| self.contact_property << RiCal::PropertyValue::Text.convert(self, val)} end
add one value to the EXDATE property one instances of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 991 def add_exdate(*ruby_value) self.exdate_property << RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value) end
add one or more values to the EXDATE property one or more instances of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 985 def add_exdates(*ruby_values) ruby_values.each {|val| self.exdate_property << RiCal::PropertyValue::OccurrenceList.convert(self, *val)} end
add one value to the EXRULE property one instances of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1117 def add_exrule(ruby_value) self.exrule_property << RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value) end
add one or more values to the EXRULE property one or more instances of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1111 def add_exrules(*ruby_values) ruby_values.each {|val| self.exrule_property << RiCal::PropertyValue::RecurrenceRule.convert(self, val)} end
add one or more values to the CATEGORIES property one or more instances of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 796 def add_multiple_categories(*ruby_values) ruby_values.each {|val| self.categories_property << RiCal::PropertyValue::Array.convert(self, val)} end
add one or more values to the RESOURCES property one or more instances of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1297 def add_multiple_resources(*ruby_values) ruby_values.each {|val| self.resources_property << RiCal::PropertyValue::Array.convert(self, val)} end
add one value to the RDATE property one instances of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1054 def add_rdate(*ruby_value) self.rdate_property << RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value) end
add one or more values to the RDATE property one or more instances of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1048 def add_rdates(*ruby_values) ruby_values.each {|val| self.rdate_property << RiCal::PropertyValue::OccurrenceList.convert(self, *val)} end
add one value to the REQUEST-STATUS property one instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1177 def add_request_status(ruby_value) self.request_status_property << RiCal::PropertyValue::Text.convert(self, ruby_value) end
add one or more values to the REQUEST-STATUS property one or more instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1171 def add_request_statuses(*ruby_values) ruby_values.each {|val| self.request_status_property << RiCal::PropertyValue::Text.convert(self, val)} end
add one value to the RESOURCES property one instances of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1303 def add_resources(ruby_value) self.resources_property << RiCal::PropertyValue::Array.convert(self, ruby_value) end
add one value to the RRULE property one instances of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1366 def add_rrule(ruby_value) self.rrule_property << RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value) end
add one or more values to the RRULE property one or more instances of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1360 def add_rrules(*ruby_values) ruby_values.each {|val| self.rrule_property << RiCal::PropertyValue::RecurrenceRule.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/event.rb, line 694 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/event.rb, line 664 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
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/event.rb, line 646 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/event.rb, line 652 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/event.rb, line 658 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/event.rb, line 757 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/event.rb, line 727 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
The property defines an ‘Attendee’ within a calendar component.
see RFC 2445 4.8.4.1 pp 102-104
# File lib/ri_cal/properties/event.rb, line 709 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/event.rb, line 715 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/event.rb, line 721 def attendees=(ruby_values) @attendee_property = ruby_values.map {|val| RiCal::PropertyValue::CalAddress.convert(self, val)} end
return the value of the CATEGORIES property which will be an array of instances of Array
# File lib/ri_cal/properties/event.rb, line 820 def categories categories_property.map {|prop| prop ? prop.ruby_value : prop} end
set the value of the CATEGORIES property to a single value one instance of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 790 def categories=(ruby_value) @categories_property = [RiCal::PropertyValue::Array.convert(self, ruby_value)] end
return the the CATEGORIES property which will be an array of instances of RiCal::PropertyValueArray
This property defines the categories for a calendar component.
see RFC 2445 4.8.1.2 pp 78-79
# File lib/ri_cal/properties/event.rb, line 772 def categories_property @categories_property ||= [] end
set the the CATEGORIES property one or more instances of RiCal::PropertyValueArray may be passed to this method
# File lib/ri_cal/properties/event.rb, line 778 def categories_property=(*property_values) @categories_property= property_values end
return the the CLASS property which will be an instances of RiCal::PropertyValueText
This property defines the access classification for a calendar component.
see RFC 2445 4.8.1.3 pp 79-80
# File lib/ri_cal/properties/event.rb, line 17 def class_property @class_property end
set the CLASS property property value should be an instance of RiCal::PropertyValueText
# File lib/ri_cal/properties/event.rb, line 23 def class_property=(property_value) @class_property = property_value end
set the value of the COMMENT property to a single value one instance of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 853 def comment=(ruby_value) @comment_property = [RiCal::PropertyValue::Text.convert(self, ruby_value)] end
return the the COMMENT property which will be an array of instances of RiCal::PropertyValueText
This property specifies non-processing information intended to provide a comment to the calendar user.
see RFC 2445 4.8.1.4 pp 80-81
# File lib/ri_cal/properties/event.rb, line 835 def comment_property @comment_property ||= [] end
set the the COMMENT property one or more instances of RiCal::PropertyValueText may be passed to this method
# File lib/ri_cal/properties/event.rb, line 841 def comment_property=(*property_values) @comment_property= property_values end
set the value of the COMMENT property to multiple values one or more instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 847 def comments=(ruby_values) @comment_property = ruby_values.map {|val| RiCal::PropertyValue::Text.convert(self, val)} end
return the value of the CONTACT property which will be an array of instances of String
# File lib/ri_cal/properties/event.rb, line 946 def contact contact_property.map {|prop| prop ? prop.ruby_value : prop} end
set the value of the CONTACT property to a single value one instance of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 916 def contact=(ruby_value) @contact_property = [RiCal::PropertyValue::Text.convert(self, ruby_value)] end
return the the CONTACT property which will be an array of instances of RiCal::PropertyValueText
The property is used to represent contact information oralternately a reference to contact information associated with the calendar component.
see RFC 2445 4.8.4.2 pp 104-106
# File lib/ri_cal/properties/event.rb, line 898 def contact_property @contact_property ||= [] end
set the the CONTACT property one or more instances of RiCal::PropertyValueText may be passed to this method
# File lib/ri_cal/properties/event.rb, line 904 def contact_property=(*property_values) @contact_property= property_values end
set the value of the CONTACT property to multiple values one or more instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 910 def contacts=(ruby_values) @contact_property = ruby_values.map {|val| RiCal::PropertyValue::Text.convert(self, val)} end
return the value of the CREATED property which will be an instance of ZuluDateTime
# File lib/ri_cal/properties/event.rb, line 67 def created created_property ? created_property.ruby_value : nil end
set the value of the CREATED property
# File lib/ri_cal/properties/event.rb, line 61 def created=(ruby_value) self.created_property= RiCal::PropertyValue::ZuluDateTime.convert(self, ruby_value) end
return the the CREATED property which will be an instances of RiCal::PropertyValueZuluDateTime
This property specifies the date and time that the calendar information was created by teh calendar user agent in the calendar store.
see RFC 2445 4.8.7.1 pp 129-130
# File lib/ri_cal/properties/event.rb, line 50 def created_property @created_property end
set the CREATED property property value should be an instance of RiCal::PropertyValueZuluDateTime
# File lib/ri_cal/properties/event.rb, line 56 def created_property=(property_value) @created_property = property_value end
return the value of the DESCRIPTION property which will be an instance of String
# File lib/ri_cal/properties/event.rb, line 100 def description description_property ? description_property.ruby_value : nil end
set the value of the DESCRIPTION property
# File lib/ri_cal/properties/event.rb, line 94 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
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/event.rb, line 83 def description_property @description_property end
set the DESCRIPTION property property value should be an instance of RiCal::PropertyValueText
# File lib/ri_cal/properties/event.rb, line 89 def description_property=(property_value) @description_property = property_value end
return the value of the DTEND property which will be an instance of either DateTime or Date
# File lib/ri_cal/properties/event.rb, line 596 def dtend dtend_property ? dtend_property.ruby_value : nil end
set the value of the DTEND property
# File lib/ri_cal/properties/event.rb, line 590 def dtend=(ruby_value) self.dtend_property= RiCal::PropertyValue::DateTime.convert(self, ruby_value) end
return the the DTEND property which will be an instances of either RiCal::PropertyValue::DateTime or RiCal::PropertyValue::Date
This property specifies the date and time that a calendar component ends.
see RFC 2445 4.8.2.2 pp 91-92
# File lib/ri_cal/properties/event.rb, line 578 def dtend_property @dtend_property end
set the DTEND property property value should be an instance of either RiCal::PropertyValue::DateTime or RiCal::PropertyValue::Date
# File lib/ri_cal/properties/event.rb, line 584 def dtend_property=(property_value) @dtend_property = property_value ? property_value.for_parent(self) : nil @duration_property = nil end
return the value of the DTSTAMP property which will be an instance of ZuluDateTime
# File lib/ri_cal/properties/event.rb, line 331 def dtstamp dtstamp_property ? dtstamp_property.ruby_value : nil end
set the value of the DTSTAMP property
# File lib/ri_cal/properties/event.rb, line 325 def dtstamp=(ruby_value) self.dtstamp_property= RiCal::PropertyValue::ZuluDateTime.convert(self, ruby_value) end
return the the DTSTAMP property which will be an instances of RiCal::PropertyValueZuluDateTime
This property indicates the date/time that the instance of the iCalendar object was created.
see RFC 2445 4.8.7.2 pp 130-131
# File lib/ri_cal/properties/event.rb, line 314 def dtstamp_property @dtstamp_property end
set the DTSTAMP property property value should be an instance of RiCal::PropertyValueZuluDateTime
# File lib/ri_cal/properties/event.rb, line 320 def dtstamp_property=(property_value) @dtstamp_property = property_value end
return the value of the DTSTART property which will be an instance of either DateTime or Date
# File lib/ri_cal/properties/event.rb, line 133 def dtstart dtstart_property ? dtstart_property.ruby_value : nil end
set the value of the DTSTART property
# File lib/ri_cal/properties/event.rb, line 127 def dtstart=(ruby_value) self.dtstart_property= RiCal::PropertyValue::DateTime.convert(self, ruby_value) end
return the the DTSTART property which will be an instances of either RiCal::PropertyValue::DateTime or RiCal::PropertyValue::Date
This property specifies when the calendar component begins.
see RFC 2445 4.8.2.4 pp 93-94
# File lib/ri_cal/properties/event.rb, line 116 def dtstart_property @dtstart_property end
set the DTSTART property property value should be an instance of either RiCal::PropertyValue::DateTime or RiCal::PropertyValue::Date
# File lib/ri_cal/properties/event.rb, line 122 def dtstart_property=(property_value) @dtstart_property = property_value ? property_value.for_parent(self) : nil end
return the value of the DURATION property which will be an instance of Duration
# File lib/ri_cal/properties/event.rb, line 630 def duration duration_property ? duration_property.ruby_value : nil end
set the value of the DURATION property
# File lib/ri_cal/properties/event.rb, line 624 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
This property specifies a positive duration of time.
see RFC 2445 4.8.2.5 pp 94-95
# File lib/ri_cal/properties/event.rb, line 612 def duration_property @duration_property end
set the DURATION property property value should be an instance of RiCal::PropertyValueDuration
# File lib/ri_cal/properties/event.rb, line 618 def duration_property=(property_value) @duration_property = property_value @dtend_property = nil end
return the value of the EXDATE property which will be an array of instances of OccurrenceList
# File lib/ri_cal/properties/event.rb, line 1009 def exdate exdate_property.map {|prop| prop ? prop.ruby_value : prop} end
set the value of the EXDATE property to a single value one instance of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 979 def exdate=(*ruby_value) @exdate_property = [RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value)] end
return the the EXDATE property which will be an array of instances of RiCal::PropertyValueOccurrenceList
This property defines the list of date/time exceptions for a recurring calendar component.
see RFC 2445 4.8.5.1 pp 112-114
# File lib/ri_cal/properties/event.rb, line 961 def exdate_property @exdate_property ||= [] end
set the the EXDATE property one or more instances of RiCal::PropertyValueOccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 967 def exdate_property=(*property_values) @exdate_property= property_values.map{|prop| prop.for_parent(self)} end
set the value of the EXDATE property to multiple values one or more instances of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 973 def exdates=(ruby_values) @exdate_property = ruby_values.map {|val| RiCal::PropertyValue::OccurrenceList.convert(self, *val)} end
return the value of the EXRULE property which will be an array of instances of RecurrenceRule
# File lib/ri_cal/properties/event.rb, line 1135 def exrule exrule_property.map {|prop| prop ? prop.ruby_value : prop} end
set the value of the EXRULE property to a single value one instance of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1105 def exrule=(ruby_value) @exrule_property = [RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value)] end
return the the EXRULE property which will be an array of instances of RiCal::PropertyValueRecurrenceRule
This property defines a rule or repeating pattern for an exception to a recurrence set.
see RFC 2445 4.8.5.2 pp 114-125
# File lib/ri_cal/properties/event.rb, line 1087 def exrule_property @exrule_property ||= [] end
set the the EXRULE property one or more instances of RiCal::PropertyValueRecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1093 def exrule_property=(*property_values) @exrule_property= property_values end
set the value of the EXRULE property to multiple values one or more instances of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1099 def exrules=(ruby_values) @exrule_property = ruby_values.map {|val| RiCal::PropertyValue::RecurrenceRule.convert(self, val)} end
return the value of the GEO property which will be an instance of Geo
# File lib/ri_cal/properties/event.rb, line 166 def geo geo_property ? geo_property.ruby_value : nil end
set the value of the GEO property
# File lib/ri_cal/properties/event.rb, line 160 def geo=(ruby_value) self.geo_property= RiCal::PropertyValue::Geo.convert(self, ruby_value) end
return the the GEO property which will be an instances of RiCal::PropertyValueGeo
This property specifies information related to the global position for the activity specified by a calendar component.
see RFC 2445 4.8.1.6 pp 82-83
# File lib/ri_cal/properties/event.rb, line 149 def geo_property @geo_property end
set the GEO property property value should be an instance of RiCal::PropertyValueGeo
# File lib/ri_cal/properties/event.rb, line 155 def geo_property=(property_value) @geo_property = property_value end
return the value of the LAST-MODIFIED property which will be an instance of ZuluDateTime
# File lib/ri_cal/properties/event.rb, line 199 def last_modified last_modified_property ? last_modified_property.ruby_value : nil end
set the value of the LAST-MODIFIED property
# File lib/ri_cal/properties/event.rb, line 193 def last_modified=(ruby_value) self.last_modified_property= RiCal::PropertyValue::ZuluDateTime.convert(self, ruby_value) end
return the the LAST-MODIFIED property which will be an instances of RiCal::PropertyValueZuluDateTime
This property specifies the date and time that the information associated with the calendar component was last revised in teh calendar store.
see RFC 2445 4.8.7.3 p 131
# File lib/ri_cal/properties/event.rb, line 182 def last_modified_property @last_modified_property end
set the LAST-MODIFIED property property value should be an instance of RiCal::PropertyValueZuluDateTime
# File lib/ri_cal/properties/event.rb, line 188 def last_modified_property=(property_value) @last_modified_property = property_value end
return the value of the LOCATION property which will be an instance of String
# File lib/ri_cal/properties/event.rb, line 232 def location location_property ? location_property.ruby_value : nil end
set the value of the LOCATION property
# File lib/ri_cal/properties/event.rb, line 226 def location=(ruby_value) self.location_property= RiCal::PropertyValue::Text.convert(self, ruby_value) end
return the the LOCATION property which will be an instances of RiCal::PropertyValueText
This property defines the intended venue for the activity defined by a calendar component.
see RFC 2445 4.8.1.7 pp 84
# File lib/ri_cal/properties/event.rb, line 215 def location_property @location_property end
set the LOCATION property property value should be an instance of RiCal::PropertyValueText
# File lib/ri_cal/properties/event.rb, line 221 def location_property=(property_value) @location_property = property_value end
set the value of the CATEGORIES property to multiple values one or more instances of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 784 def multiple_categories=(ruby_values) @categories_property = ruby_values.map {|val| RiCal::PropertyValue::Array.convert(self, val)} end
set the value of the RESOURCES property to multiple values one or more instances of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1285 def multiple_resources=(ruby_values) @resources_property = ruby_values.map {|val| RiCal::PropertyValue::Array.convert(self, val)} end
return the value of the ORGANIZER property which will be an instance of CalAddress
# File lib/ri_cal/properties/event.rb, line 265 def organizer organizer_property ? organizer_property.ruby_value : nil end
set the value of the ORGANIZER property
# File lib/ri_cal/properties/event.rb, line 259 def organizer=(ruby_value) self.organizer_property= RiCal::PropertyValue::CalAddress.convert(self, ruby_value) end
return the the ORGANIZER property which will be an instances of RiCal::PropertyValueCalAddress
The property defines the organizer for a calendar component.
see RFC 2445 4.8.4.3 pp 106-107
# File lib/ri_cal/properties/event.rb, line 248 def organizer_property @organizer_property end
set the ORGANIZER property property value should be an instance of RiCal::PropertyValueCalAddress
# File lib/ri_cal/properties/event.rb, line 254 def organizer_property=(property_value) @organizer_property = property_value end
return the value of the PRIORITY property which will be an instance of Integer
# File lib/ri_cal/properties/event.rb, line 298 def priority priority_property ? priority_property.ruby_value : nil end
set the value of the PRIORITY property
# File lib/ri_cal/properties/event.rb, line 292 def priority=(ruby_value) self.priority_property= RiCal::PropertyValue::Integer.convert(self, ruby_value) end
return the the PRIORITY property which will be an instances of RiCal::PropertyValueInteger
This property defines the relative priority for a calendar component.
see RFC 2445 4.8.1.9 pp 85-87
# File lib/ri_cal/properties/event.rb, line 281 def priority_property @priority_property end
set the PRIORITY property property value should be an instance of RiCal::PropertyValueInteger
# File lib/ri_cal/properties/event.rb, line 287 def priority_property=(property_value) @priority_property = property_value end
return the value of the RDATE property which will be an array of instances of OccurrenceList
# File lib/ri_cal/properties/event.rb, line 1072 def rdate rdate_property.map {|prop| prop ? prop.ruby_value : prop} end
set the value of the RDATE property to a single value one instance of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1042 def rdate=(*ruby_value) @rdate_property = [RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value)] end
return the the RDATE property which will be an array of instances of RiCal::PropertyValueOccurrenceList
This property defines the list of date/times for a recurring calendar component.
see RFC 2445 4.8.5.3 pp 115-117
# File lib/ri_cal/properties/event.rb, line 1024 def rdate_property @rdate_property ||= [] end
set the the RDATE property one or more instances of RiCal::PropertyValueOccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1030 def rdate_property=(*property_values) @rdate_property= property_values.map{|prop| prop.for_parent(self)} end
set the value of the RDATE property to multiple values one or more instances of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1036 def rdates=(ruby_values) @rdate_property = ruby_values.map {|val| RiCal::PropertyValue::OccurrenceList.convert(self, *val)} end
return the value of the RECURRENCE-ID property which will be an instance of either DateTime or Date
# File lib/ri_cal/properties/event.rb, line 562 def recurrence_id recurrence_id_property ? recurrence_id_property.ruby_value : nil end
set the value of the RECURRENCE-ID property
# File lib/ri_cal/properties/event.rb, line 556 def recurrence_id=(ruby_value) self.recurrence_id_property= RiCal::PropertyValue::DateTime.convert(self, ruby_value) end
return the the RECURRENCE-ID property which will be an instances of either RiCal::PropertyValue::DateTime or RiCal::PropertyValue::Date
This property is used in conjunction with the “UID” and “SEQUENCE” property to identify a specific instance of a recurring “VEVENT”, “VTODO” or “VJOURNAL” calendar component. The property value is the effective value of the “DTSTART” property of the recurrence instance.
see RFC 2445 4.8.4.4 pp 107-109
# File lib/ri_cal/properties/event.rb, line 545 def recurrence_id_property @recurrence_id_property end
set the RECURRENCE-ID property property value should be an instance of either RiCal::PropertyValue::DateTime or RiCal::PropertyValue::Date
# File lib/ri_cal/properties/event.rb, line 551 def recurrence_id_property=(property_value) @recurrence_id_property = property_value ? property_value.for_parent(self) : nil end
remove one value from the ATTACH property one instances of Uri may be passed to this method
# File lib/ri_cal/properties/event.rb, line 688 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/event.rb, line 682 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/event.rb, line 751 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/event.rb, line 745 def remove_attendees(*ruby_values) ruby_values.each {|val| self.attendee_property.delete(RiCal::PropertyValue::CalAddress.convert(self, val))} end
remove one value from the CATEGORIES property one instances of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 814 def remove_categories(ruby_value) self.categories_property.delete(RiCal::PropertyValue::Array.convert(self, ruby_value)) end
remove one value from the COMMENT property one instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 877 def remove_comment(ruby_value) self.comment_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value)) end
remove one or more values from the COMMENT property one or more instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 871 def remove_comments(*ruby_values) ruby_values.each {|val| self.comment_property.delete(RiCal::PropertyValue::Text.convert(self, val))} end
remove one value from the CONTACT property one instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 940 def remove_contact(ruby_value) self.contact_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value)) end
remove one or more values from the CONTACT property one or more instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 934 def remove_contacts(*ruby_values) ruby_values.each {|val| self.contact_property.delete(RiCal::PropertyValue::Text.convert(self, val))} end
remove one value from the EXDATE property one instances of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1003 def remove_exdate(*ruby_value) self.exdate_property.delete(RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value)) end
remove one or more values from the EXDATE property one or more instances of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 997 def remove_exdates(*ruby_values) ruby_values.each {|val| self.exdate_property.delete(RiCal::PropertyValue::OccurrenceList.convert(self, *val))} end
remove one value from the EXRULE property one instances of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1129 def remove_exrule(ruby_value) self.exrule_property.delete(RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value)) end
remove one or more values from the EXRULE property one or more instances of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1123 def remove_exrules(*ruby_values) ruby_values.each {|val| self.exrule_property.delete(RiCal::PropertyValue::RecurrenceRule.convert(self, val))} end
remove one or more values from the CATEGORIES property one or more instances of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 808 def remove_multiple_categories(*ruby_values) ruby_values.each {|val| self.categories_property.delete(RiCal::PropertyValue::Array.convert(self, val))} end
remove one or more values from the RESOURCES property one or more instances of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1309 def remove_multiple_resources(*ruby_values) ruby_values.each {|val| self.resources_property.delete(RiCal::PropertyValue::Array.convert(self, val))} end
remove one value from the RDATE property one instances of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1066 def remove_rdate(*ruby_value) self.rdate_property.delete(RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value)) end
remove one or more values from the RDATE property one or more instances of OccurrenceList may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1060 def remove_rdates(*ruby_values) ruby_values.each {|val| self.rdate_property.delete(RiCal::PropertyValue::OccurrenceList.convert(self, *val))} end
remove one value from the REQUEST-STATUS property one instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1189 def remove_request_status(ruby_value) self.request_status_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value)) end
remove one or more values from the REQUEST-STATUS property one or more instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1183 def remove_request_statuses(*ruby_values) ruby_values.each {|val| self.request_status_property.delete(RiCal::PropertyValue::Text.convert(self, val))} end
remove one value from the RESOURCES property one instances of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1315 def remove_resources(ruby_value) self.resources_property.delete(RiCal::PropertyValue::Array.convert(self, ruby_value)) end
remove one value from the RRULE property one instances of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1378 def remove_rrule(ruby_value) self.rrule_property.delete(RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value)) end
remove one or more values from the RRULE property one or more instances of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1372 def remove_rrules(*ruby_values) ruby_values.each {|val| self.rrule_property.delete(RiCal::PropertyValue::RecurrenceRule.convert(self, val))} end
return the value of the REQUEST-STATUS property which will be an array of instances of String
# File lib/ri_cal/properties/event.rb, line 1195 def request_status request_status_property.map {|prop| prop ? prop.ruby_value : prop} end
set the value of the REQUEST-STATUS property to a single value one instance of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1165 def request_status=(ruby_value) @request_status_property = [RiCal::PropertyValue::Text.convert(self, ruby_value)] end
return the the REQUEST-STATUS property which will be an array of instances of RiCal::PropertyValueText
see RFC 2445 4.8.8.2 pp 134-136
# File lib/ri_cal/properties/event.rb, line 1147 def request_status_property @request_status_property ||= [] end
set the the REQUEST-STATUS property one or more instances of RiCal::PropertyValueText may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1153 def request_status_property=(*property_values) @request_status_property= property_values end
set the value of the REQUEST-STATUS property to multiple values one or more instances of String may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1159 def request_statuses=(ruby_values) @request_status_property = ruby_values.map {|val| RiCal::PropertyValue::Text.convert(self, val)} end
return the value of the RESOURCES property which will be an array of instances of Array
# File lib/ri_cal/properties/event.rb, line 1321 def resources resources_property.map {|prop| prop ? prop.ruby_value : prop} end
set the value of the RESOURCES property to a single value one instance of Array may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1291 def resources=(ruby_value) @resources_property = [RiCal::PropertyValue::Array.convert(self, ruby_value)] end
return the the RESOURCES property which will be an array of instances of RiCal::PropertyValueArray
This property defines the equipment or resources anticipated for an activity specified by a calendar entity.
see RFC 2445 4.8.1.10 pp 87-88
# File lib/ri_cal/properties/event.rb, line 1273 def resources_property @resources_property ||= [] end
set the the RESOURCES property one or more instances of RiCal::PropertyValueArray may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1279 def resources_property=(*property_values) @resources_property= property_values end
return the value of the RRULE property which will be an array of instances of RecurrenceRule
# File lib/ri_cal/properties/event.rb, line 1384 def rrule rrule_property.map {|prop| prop ? prop.ruby_value : prop} end
set the value of the RRULE property to a single value one instance of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1354 def rrule=(ruby_value) @rrule_property = [RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value)] end
return the the RRULE property which will be an array of instances of RiCal::PropertyValueRecurrenceRule
This property defines a rule or repeating pattern for recurring events, to-dos, or time zone definitions.
see RFC 2445 4.8.5.4 pp 117-125
# File lib/ri_cal/properties/event.rb, line 1336 def rrule_property @rrule_property ||= [] end
set the the RRULE property one or more instances of RiCal::PropertyValueRecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1342 def rrule_property=(*property_values) @rrule_property= property_values end
set the value of the RRULE property to multiple values one or more instances of RecurrenceRule may be passed to this method
# File lib/ri_cal/properties/event.rb, line 1348 def rrules=(ruby_values) @rrule_property = ruby_values.map {|val| RiCal::PropertyValue::RecurrenceRule.convert(self, val)} end
return the value of the CLASS property which will be an instance of String
# File lib/ri_cal/properties/event.rb, line 34 def security_class class_property ? class_property.ruby_value : nil end
set the value of the CLASS property
# File lib/ri_cal/properties/event.rb, line 28 def security_class=(ruby_value) self.class_property= RiCal::PropertyValue::Text.convert(self, ruby_value) end
return the value of the SEQUENCE property which will be an instance of Integer
# File lib/ri_cal/properties/event.rb, line 364 def sequence sequence_property ? sequence_property.ruby_value : nil end
set the value of the SEQUENCE property
# File lib/ri_cal/properties/event.rb, line 358 def sequence=(ruby_value) self.sequence_property= RiCal::PropertyValue::Integer.convert(self, ruby_value) end
return the the SEQUENCE property which will be an instances of RiCal::PropertyValueInteger
This property defines the revision sequence number of the calendar component within a sequence of revisions.
see RFC 2445 4.8.7.4 pp 131-133
# File lib/ri_cal/properties/event.rb, line 347 def sequence_property @sequence_property end
set the SEQUENCE property property value should be an instance of RiCal::PropertyValueInteger
# File lib/ri_cal/properties/event.rb, line 353 def sequence_property=(property_value) @sequence_property = property_value end
return the value of the STATUS property which will be an instance of String
# File lib/ri_cal/properties/event.rb, line 397 def status status_property ? status_property.ruby_value : nil end
set the value of the STATUS property
# File lib/ri_cal/properties/event.rb, line 391 def status=(ruby_value) self.status_property= RiCal::PropertyValue::Text.convert(self, ruby_value) end
return the the STATUS property which will be an instances of RiCal::PropertyValueText
This property defines a short summary or subject for the calendar component.
see RFC 2445 4.8.1.11 pp 80-89
# File lib/ri_cal/properties/event.rb, line 380 def status_property @status_property end
set the STATUS property property value should be an instance of RiCal::PropertyValueText
# File lib/ri_cal/properties/event.rb, line 386 def status_property=(property_value) @status_property = property_value end
return the value of the SUMMARY property which will be an instance of String
# File lib/ri_cal/properties/event.rb, line 430 def summary summary_property ? summary_property.ruby_value : nil end
set the value of the SUMMARY property
# File lib/ri_cal/properties/event.rb, line 424 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
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/event.rb, line 413 def summary_property @summary_property end
set the SUMMARY property property value should be an instance of RiCal::PropertyValueText
# File lib/ri_cal/properties/event.rb, line 419 def summary_property=(property_value) @summary_property = property_value end
return the value of the TRANSP property which will be an instance of String
# File lib/ri_cal/properties/event.rb, line 463 def transp transp_property ? transp_property.ruby_value : nil end
set the value of the TRANSP property
# File lib/ri_cal/properties/event.rb, line 457 def transp=(ruby_value) self.transp_property= RiCal::PropertyValue::Text.convert(self, ruby_value) end
return the the TRANSP property which will be an instances of RiCal::PropertyValueText
This property defines whether an event is transparent or not to busy time searches.
see RFC 2445 4.8.2.7 pp 96-97
# File lib/ri_cal/properties/event.rb, line 446 def transp_property @transp_property end
set the TRANSP property property value should be an instance of RiCal::PropertyValueText
# File lib/ri_cal/properties/event.rb, line 452 def transp_property=(property_value) @transp_property = property_value end
return the value of the UID property which will be an instance of String
# File lib/ri_cal/properties/event.rb, line 496 def uid uid_property ? uid_property.ruby_value : nil end
set the value of the UID property
# File lib/ri_cal/properties/event.rb, line 490 def uid=(ruby_value) self.uid_property= RiCal::PropertyValue::Text.convert(self, ruby_value) end
return the the UID property which will be an instances of RiCal::PropertyValueText
This property defines the persistent, globally unique identifier for the calendar component.
see RFC 2445 4.8.4.7 pp 111-112
# File lib/ri_cal/properties/event.rb, line 479 def uid_property @uid_property end
set the UID property property value should be an instance of RiCal::PropertyValueText
# File lib/ri_cal/properties/event.rb, line 485 def uid_property=(property_value) @uid_property = property_value end
return the value of the URL property which will be an instance of Uri
# File lib/ri_cal/properties/event.rb, line 529 def url url_property ? url_property.ruby_value : nil end
set the value of the URL property
# File lib/ri_cal/properties/event.rb, line 523 def url=(ruby_value) self.url_property= RiCal::PropertyValue::Uri.convert(self, ruby_value) end
return the the URL property which will be an instances of RiCal::PropertyValueUri
This property defines a Uniform Resource Locator (URL) associated with the iCalendar object.
see RFC 2445 4.8.4.6 pp 110-111
# File lib/ri_cal/properties/event.rb, line 512 def url_property @url_property end
Generated with the Darkfish Rdoc Generator 2.
return the value of the COMMENT property which will be an array of instances of String