RiCal::Properties::TimezonePeriod

 Properties::TimezonePeriod provides property accessing methods for the TimezonePeriod class
 This source file is generated by the  rical:gen_propmodules rake tasks, DO NOT EDIT

Public Instance Methods

add_comment(ruby_value) click to toggle source

add one value to the COMMENT property one instances of String may be passed to this method

# File lib/ri_cal/properties/timezone_period.rb, line 146
      def  add_comment(ruby_value)
       self.comment_property << RiCal::PropertyValue::Text.convert(self, ruby_value)
      end
add_comments(*ruby_values) click to toggle source

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/timezone_period.rb, line 140
      def  add_comments(*ruby_values)
       ruby_values.each {|val|  self.comment_property << RiCal::PropertyValue::Text.convert(self, val)}
      end
add_rdate(*ruby_value) click to toggle source

add one value to the RDATE property one instances of OccurrenceList may be passed to this method

# File lib/ri_cal/properties/timezone_period.rb, line 209
      def  add_rdate(*ruby_value)
       self.rdate_property << RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value)
      end
add_rdates(*ruby_values) click to toggle source

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/timezone_period.rb, line 203
      def  add_rdates(*ruby_values)
       ruby_values.each {|val|  self.rdate_property << RiCal::PropertyValue::OccurrenceList.convert(self, *val)}
      end
add_rrule(ruby_value) click to toggle source

add one value to the RRULE property one instances of RecurrenceRule may be passed to this method

# File lib/ri_cal/properties/timezone_period.rb, line 272
      def  add_rrule(ruby_value)
       self.rrule_property << RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value)
      end
add_rrules(*ruby_values) click to toggle source

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/timezone_period.rb, line 266
      def  add_rrules(*ruby_values)
       ruby_values.each {|val|  self.rrule_property << RiCal::PropertyValue::RecurrenceRule.convert(self, val)}
      end
add_tzname(ruby_value) click to toggle source

add one value to the TZNAME property one instances of String may be passed to this method

# File lib/ri_cal/properties/timezone_period.rb, line 335
      def  add_tzname(ruby_value)
       self.tzname_property << RiCal::PropertyValue::Text.convert(self, ruby_value)
      end
add_tznames(*ruby_values) click to toggle source

add one or more values to the TZNAME property one or more instances of String may be passed to this method

# File lib/ri_cal/properties/timezone_period.rb, line 329
      def  add_tznames(*ruby_values)
       ruby_values.each {|val|  self.tzname_property << RiCal::PropertyValue::Text.convert(self, val)}
      end
comment() click to toggle source

return the value of the COMMENT property which will be an array of instances of String

# File lib/ri_cal/properties/timezone_period.rb, line 164
      def comment
        comment_property.map {|prop| prop ? prop.ruby_value : prop}
      end
comment=(ruby_value) click to toggle source

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/timezone_period.rb, line 134
      def comment=(ruby_value)
        @comment_property = [RiCal::PropertyValue::Text.convert(self, ruby_value)]
      end
comment_property() click to toggle source

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

[purpose (from RFC 2445)] 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/timezone_period.rb, line 116
      def comment_property
        @comment_property ||= []
      end
comment_property=(*property_values) click to toggle source

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

# File lib/ri_cal/properties/timezone_period.rb, line 122
      def comment_property=(*property_values)
        @comment_property= property_values
      end
comments=(ruby_values) click to toggle source

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/timezone_period.rb, line 128
      def comments=(ruby_values)
        @comment_property = ruby_values.map {|val| RiCal::PropertyValue::Text.convert(self, val)}
      end
dtstart() click to toggle source

return the value of the DTSTART property which will be an instance of either DateTime or Date

# File lib/ri_cal/properties/timezone_period.rb, line 34
      def dtstart
        dtstart_property ? dtstart_property.ruby_value : nil
      end
dtstart=(ruby_value) click to toggle source

set the value of the DTSTART property

# File lib/ri_cal/properties/timezone_period.rb, line 28
      def dtstart=(ruby_value)
        self.dtstart_property= RiCal::PropertyValue::DateTime.convert(self, ruby_value)
      end
dtstart_property() click to toggle source

return the the DTSTART property which will be an instances of either RiCal::PropertyValue::DateTime or RiCal::PropertyValue::Date

[purpose (from RFC 2445)] This property specifies when the calendar component begins.

see RFC 2445 4.8.2.4 pp 93-94

# File lib/ri_cal/properties/timezone_period.rb, line 17
      def dtstart_property
        @dtstart_property
      end
dtstart_property=(property_value) click to toggle source

set the DTSTART property property value should be an instance of either RiCal::PropertyValue::DateTime or RiCal::PropertyValue::Date

# File lib/ri_cal/properties/timezone_period.rb, line 23
      def dtstart_property=(property_value)
        @dtstart_property = property_value ? property_value.for_parent(self) : nil
      end
rdate() click to toggle source

return the value of the RDATE property which will be an array of instances of OccurrenceList

# File lib/ri_cal/properties/timezone_period.rb, line 227
      def rdate
        rdate_property.map {|prop| prop ? prop.ruby_value : prop}
      end
rdate=(*ruby_value) click to toggle source

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/timezone_period.rb, line 197
      def rdate=(*ruby_value)
        @rdate_property = [RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value)]
      end
rdate_property() click to toggle source

return the the RDATE property which will be an array of instances of RiCal::PropertyValueOccurrenceList

[purpose (from RFC 2445)] 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/timezone_period.rb, line 179
      def rdate_property
        @rdate_property ||= []
      end
rdate_property=(*property_values) click to toggle source

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

# File lib/ri_cal/properties/timezone_period.rb, line 185
      def rdate_property=(*property_values)
        @rdate_property= property_values.map{|prop| prop.for_parent(self)}
      end
rdates=(ruby_values) click to toggle source

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/timezone_period.rb, line 191
      def rdates=(ruby_values)
        @rdate_property = ruby_values.map {|val| RiCal::PropertyValue::OccurrenceList.convert(self, *val)}
      end
remove_comment(ruby_value) click to toggle source

remove one value from the COMMENT property one instances of String may be passed to this method

# File lib/ri_cal/properties/timezone_period.rb, line 158
      def  remove_comment(ruby_value)
       self.comment_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value))
      end
remove_comments(*ruby_values) click to toggle source

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/timezone_period.rb, line 152
      def  remove_comments(*ruby_values)
       ruby_values.each {|val|  self.comment_property.delete(RiCal::PropertyValue::Text.convert(self, val))}
      end
remove_rdate(*ruby_value) click to toggle source

remove one value from the RDATE property one instances of OccurrenceList may be passed to this method

# File lib/ri_cal/properties/timezone_period.rb, line 221
      def  remove_rdate(*ruby_value)
       self.rdate_property.delete(RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value))
      end
remove_rdates(*ruby_values) click to toggle source

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/timezone_period.rb, line 215
      def  remove_rdates(*ruby_values)
       ruby_values.each {|val|  self.rdate_property.delete(RiCal::PropertyValue::OccurrenceList.convert(self, *val))}
      end
remove_rrule(ruby_value) click to toggle source

remove one value from the RRULE property one instances of RecurrenceRule may be passed to this method

# File lib/ri_cal/properties/timezone_period.rb, line 284
      def  remove_rrule(ruby_value)
       self.rrule_property.delete(RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value))
      end
remove_rrules(*ruby_values) click to toggle source

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/timezone_period.rb, line 278
      def  remove_rrules(*ruby_values)
       ruby_values.each {|val|  self.rrule_property.delete(RiCal::PropertyValue::RecurrenceRule.convert(self, val))}
      end
remove_tzname(ruby_value) click to toggle source

remove one value from the TZNAME property one instances of String may be passed to this method

# File lib/ri_cal/properties/timezone_period.rb, line 347
      def  remove_tzname(ruby_value)
       self.tzname_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value))
      end
remove_tznames(*ruby_values) click to toggle source

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

# File lib/ri_cal/properties/timezone_period.rb, line 341
      def  remove_tznames(*ruby_values)
       ruby_values.each {|val|  self.tzname_property.delete(RiCal::PropertyValue::Text.convert(self, val))}
      end
rrule() click to toggle source

return the value of the RRULE property which will be an array of instances of RecurrenceRule

# File lib/ri_cal/properties/timezone_period.rb, line 290
      def rrule
        rrule_property.map {|prop| prop ? prop.ruby_value : prop}
      end
rrule=(ruby_value) click to toggle source

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/timezone_period.rb, line 260
      def rrule=(ruby_value)
        @rrule_property = [RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value)]
      end
rrule_property() click to toggle source

return the the RRULE property which will be an array of instances of RiCal::PropertyValueRecurrenceRule

[purpose (from RFC 2445)] 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/timezone_period.rb, line 242
      def rrule_property
        @rrule_property ||= []
      end
rrule_property=(*property_values) click to toggle source

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

# File lib/ri_cal/properties/timezone_period.rb, line 248
      def rrule_property=(*property_values)
        @rrule_property= property_values
      end
rrules=(ruby_values) click to toggle source

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/timezone_period.rb, line 254
      def rrules=(ruby_values)
        @rrule_property = ruby_values.map {|val| RiCal::PropertyValue::RecurrenceRule.convert(self, val)}
      end
tzname() click to toggle source

return the value of the TZNAME property which will be an array of instances of String

# File lib/ri_cal/properties/timezone_period.rb, line 353
      def tzname
        tzname_property.map {|prop| prop ? prop.ruby_value : prop}
      end
tzname=(ruby_value) click to toggle source

set the value of the TZNAME property to a single value one instance of String may be passed to this method

# File lib/ri_cal/properties/timezone_period.rb, line 323
      def tzname=(ruby_value)
        @tzname_property = [RiCal::PropertyValue::Text.convert(self, ruby_value)]
      end
tzname_property() click to toggle source

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

[purpose (from RFC 2445)] This property specifies the customary designation for a time zone description.

see RFC 2445 4.8.3.2 p 99

# File lib/ri_cal/properties/timezone_period.rb, line 305
      def tzname_property
        @tzname_property ||= []
      end
tzname_property=(*property_values) click to toggle source

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

# File lib/ri_cal/properties/timezone_period.rb, line 311
      def tzname_property=(*property_values)
        @tzname_property= property_values
      end
tznames=(ruby_values) click to toggle source

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

# File lib/ri_cal/properties/timezone_period.rb, line 317
      def tznames=(ruby_values)
        @tzname_property = ruby_values.map {|val| RiCal::PropertyValue::Text.convert(self, val)}
      end
tzoffsetfrom() click to toggle source

return the value of the TZOFFSETFROM property which will be an instance of UtcOffset

# File lib/ri_cal/properties/timezone_period.rb, line 100
      def tzoffsetfrom
        tzoffsetfrom_property ? tzoffsetfrom_property.ruby_value : nil
      end
tzoffsetfrom=(ruby_value) click to toggle source

set the value of the TZOFFSETFROM property

# File lib/ri_cal/properties/timezone_period.rb, line 94
      def tzoffsetfrom=(ruby_value)
        self.tzoffsetfrom_property= RiCal::PropertyValue::UtcOffset.convert(self, ruby_value)
      end
tzoffsetfrom_property() click to toggle source

return the the TZOFFSETFROM property which will be an instances of RiCal::PropertyValueUtcOffset

[purpose (from RFC 2445)] This property specifies the offset which is in use prior to this time zone observance

see RFC 2445 4.8.3.3 pp 99-100

# File lib/ri_cal/properties/timezone_period.rb, line 83
      def tzoffsetfrom_property
        @tzoffsetfrom_property
      end
tzoffsetfrom_property=(property_value) click to toggle source

set the TZOFFSETFROM property property value should be an instance of RiCal::PropertyValueUtcOffset

# File lib/ri_cal/properties/timezone_period.rb, line 89
      def tzoffsetfrom_property=(property_value)
        @tzoffsetfrom_property = property_value
      end
tzoffsetto() click to toggle source

return the value of the TZOFFSETTO property which will be an instance of UtcOffset

# File lib/ri_cal/properties/timezone_period.rb, line 67
      def tzoffsetto
        tzoffsetto_property ? tzoffsetto_property.ruby_value : nil
      end
tzoffsetto=(ruby_value) click to toggle source

set the value of the TZOFFSETTO property

# File lib/ri_cal/properties/timezone_period.rb, line 61
      def tzoffsetto=(ruby_value)
        self.tzoffsetto_property= RiCal::PropertyValue::UtcOffset.convert(self, ruby_value)
      end
tzoffsetto_property() click to toggle source

return the the TZOFFSETTO property which will be an instances of RiCal::PropertyValueUtcOffset

[purpose (from RFC 2445)] This property specifies the offset which is in use in this time zone observance

see RFC 2445 4.8.3.4 pp 100-101

# File lib/ri_cal/properties/timezone_period.rb, line 50
      def tzoffsetto_property
        @tzoffsetto_property
      end
tzoffsetto_property=(property_value) click to toggle source

set the TZOFFSETTO property property value should be an instance of RiCal::PropertyValueUtcOffset

# File lib/ri_cal/properties/timezone_period.rb, line 56
      def tzoffsetto_property=(property_value)
        @tzoffsetto_property = property_value
      end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.