Class RiCal::PropertyValue::RecurrenceRule
In: lib/ri_cal/property_value/recurrence_rule.rb
lib/ri_cal/property_value/recurrence_rule/negative_setpos_enumerator.rb
lib/ri_cal/property_value/recurrence_rule/recurring_month_day.rb
lib/ri_cal/property_value/recurrence_rule/recurring_year_day.rb
lib/ri_cal/property_value/recurrence_rule/time_manipulation.rb
lib/ri_cal/property_value/recurrence_rule/recurring_numbered_week.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/daily_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_yearday_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_month_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_monthday_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/monthly_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/yearly_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/secondly_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/minutely_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/hourly_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_minute_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_day_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/weekly_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/null_sub_cycle_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_weekno_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/list_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_numbered_day_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/frequency_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_hour_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_second_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/recurring_day.rb
lib/ri_cal/property_value/recurrence_rule/enumerator.rb
lib/ri_cal/property_value/recurrence_rule/numbered_span.rb
lib/ri_cal/property_value/recurrence_rule/validations.rb
lib/ri_cal/property_value/recurrence_rule/initialization_methods.rb
lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer.rb
lib/ri_cal/property_value/recurrence_rule/enumeration_support_methods.rb
Parent: PropertyValue
  • ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
 RiCal::PropertyValue::RecurrenceRule represents an icalendar Recurrence Rule property value
 which is defined in
 rfc 2445 section 4.3.10 pp 40-45

Methods

bounded?   count=   freq   freq=   interval   interval=   to_ical   until   wkst   wkst=  

Included Modules

Validations InitializationMethods EnumerationSupportMethods

Attributes

count  [R]  The integer count value of the receiver, or nil
until  [R]  The DATE-TIME value of until limit of the receiver, or nil

Public Instance methods

Predicate to determine if the receiver generates a bounded or infinite set of occurrences

Set the count parameter of the recurrence rule, the count value will be converted to an integer using to_i

This method resets the receivers list of errors

return the frequency of the rule which will be a string

Set the frequency of the recurrence rule

freq_value:a String which should be in %w[SECONDLY MINUTELY HOURLY DAILY WEEKLY MONTHLY YEARLY]

This method resets the receivers list of errors

return the INTERVAL parameter of the recurrence rule This returns an Integer

Set the INTERVAL parameter of the recurrence rule

interval_value:an Integer

This method resets the receivers list of errors

Return a string containing the RFC 2445 representation of the recurrence rule

Set the until parameter of the recurrence rule

until_value:the value to be set, this may be either a string in RFC 2446 Date or DateTime value format

Or a Date, Time, DateTime, RiCal::PropertyValue::Date, or RiCal::PropertyValue::DateTime

return the starting week day for the recurrence rule, which for a valid instance will be one of "SU", "MO", "TU", "WE", "TH", "FR", or "SA"

Set the starting week day for the recurrence rule, which should be one of "SU", "MO", "TU", "WE", "TH", "FR", or "SA" for the instance to be valid. The parameter is however case-insensitive.

This method resets the receivers list of errors

[Validate]