RiCal::Properties::Freebusy

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

Public Instance Methods

add_attendee(ruby_value) click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 311
      def  add_attendee(ruby_value)
       self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, ruby_value)
      end
add_attendees(*ruby_values) click to toggle source

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/freebusy.rb, line 305
      def  add_attendees(*ruby_values)
       ruby_values.each {|val|  self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, val)}
      end
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/freebusy.rb, line 374
      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/freebusy.rb, line 368
      def  add_comments(*ruby_values)
       ruby_values.each {|val|  self.comment_property << RiCal::PropertyValue::Text.convert(self, val)}
      end
add_freebusy(ruby_value) click to toggle source

add one value to the FREEBUSY property one instances of Period may be passed to this method

# File lib/ri_cal/properties/freebusy.rb, line 437
      def  add_freebusy(ruby_value)
       self.freebusy_property << RiCal::PropertyValue::Period.convert(self, ruby_value)
      end
add_freebusys(*ruby_values) click to toggle source

add one or more values to the FREEBUSY property one or more instances of Period may be passed to this method

# File lib/ri_cal/properties/freebusy.rb, line 431
      def  add_freebusys(*ruby_values)
       ruby_values.each {|val|  self.freebusy_property << RiCal::PropertyValue::Period.convert(self, val)}
      end
add_request_status(ruby_value) click to toggle source

add one value to the REQUEST-STATUS property one instances of String may be passed to this method

# File lib/ri_cal/properties/freebusy.rb, line 497
      def  add_request_status(ruby_value)
       self.request_status_property << RiCal::PropertyValue::Text.convert(self, ruby_value)
      end
add_request_statuses(*ruby_values) click to toggle source

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/freebusy.rb, line 491
      def  add_request_statuses(*ruby_values)
       ruby_values.each {|val|  self.request_status_property << RiCal::PropertyValue::Text.convert(self, val)}
      end
attendee() click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 329
      def attendee
        attendee_property.map {|prop| prop ? prop.ruby_value : prop}
      end
attendee=(ruby_value) click to toggle source

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/freebusy.rb, line 299
      def attendee=(ruby_value)
        @attendee_property = [RiCal::PropertyValue::CalAddress.convert(self, ruby_value)]
      end
attendee_property() click to toggle source

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/freebusy.rb, line 281
      def attendee_property
        @attendee_property ||= []
      end
attendee_property=(*property_values) click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 287
      def attendee_property=(*property_values)
        @attendee_property= property_values
      end
attendees=(ruby_values) click to toggle source

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/freebusy.rb, line 293
      def attendees=(ruby_values)
        @attendee_property = ruby_values.map {|val| RiCal::PropertyValue::CalAddress.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/freebusy.rb, line 392
      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/freebusy.rb, line 362
      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/freebusy.rb, line 344
      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/freebusy.rb, line 350
      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/freebusy.rb, line 356
      def comments=(ruby_values)
        @comment_property = ruby_values.map {|val| RiCal::PropertyValue::Text.convert(self, val)}
      end
contact() click to toggle source

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

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

set the value of the CONTACT property

# File lib/ri_cal/properties/freebusy.rb, line 28
      def contact=(ruby_value)
        self.contact_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
      end
contact_property() click to toggle source

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

[purpose (from RFC 2445)] 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/freebusy.rb, line 17
      def contact_property
        @contact_property
      end
contact_property=(property_value) click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 23
      def contact_property=(property_value)
        @contact_property = property_value
      end
dtend() click to toggle source

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

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

set the value of the DTEND property

# File lib/ri_cal/properties/freebusy.rb, line 94
      def dtend=(ruby_value)
        self.dtend_property= RiCal::PropertyValue::DateTime.convert(self, ruby_value)
      end
dtend_property() click to toggle source

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

[purpose (from RFC 2445)] 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/freebusy.rb, line 83
      def dtend_property
        @dtend_property
      end
dtend_property=(property_value) click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 89
      def dtend_property=(property_value)
        @dtend_property = property_value ? property_value.for_parent(self) : nil
      end
dtstamp() click to toggle source

return the value of the DTSTAMP property which will be an instance of DateTime

# File lib/ri_cal/properties/freebusy.rb, line 166
      def dtstamp
        dtstamp_property ? dtstamp_property.ruby_value : nil
      end
dtstamp=(ruby_value) click to toggle source

set the value of the DTSTAMP property

# File lib/ri_cal/properties/freebusy.rb, line 160
      def dtstamp=(ruby_value)
        self.dtstamp_property= RiCal::PropertyValue::DateTime.convert(self, ruby_value)
      end
dtstamp_property() click to toggle source

return the the DTSTAMP property which will be an instances of RiCal::PropertyValueDateTime

[purpose (from RFC 2445)] 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/freebusy.rb, line 149
      def dtstamp_property
        @dtstamp_property
      end
dtstamp_property=(property_value) click to toggle source

set the DTSTAMP property property value should be an instance of RiCal::PropertyValueDateTime

# File lib/ri_cal/properties/freebusy.rb, line 155
      def dtstamp_property=(property_value)
        @dtstamp_property = property_value ? property_value.for_parent(self) : nil
      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/freebusy.rb, line 67
      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/freebusy.rb, line 61
      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/freebusy.rb, line 50
      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/freebusy.rb, line 56
      def dtstart_property=(property_value)
        @dtstart_property = property_value ? property_value.for_parent(self) : nil
      end
duration() click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 133
      def duration
        duration_property ? duration_property.ruby_value : nil
      end
duration=(ruby_value) click to toggle source

set the value of the DURATION property

# File lib/ri_cal/properties/freebusy.rb, line 127
      def duration=(ruby_value)
        self.duration_property= RiCal::PropertyValue::Duration.convert(self, ruby_value)
      end
duration_property() click to toggle source

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/freebusy.rb, line 116
      def duration_property
        @duration_property
      end
duration_property=(property_value) click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 122
      def duration_property=(property_value)
        @duration_property = property_value
      end
freebusy() click to toggle source

return the value of the FREEBUSY property which will be an array of instances of Period

# File lib/ri_cal/properties/freebusy.rb, line 455
      def freebusy
        freebusy_property.map {|prop| prop ? prop.ruby_value : prop}
      end
freebusy=(ruby_value) click to toggle source

set the value of the FREEBUSY property to a single value one instance of Period may be passed to this method

# File lib/ri_cal/properties/freebusy.rb, line 425
      def freebusy=(ruby_value)
        @freebusy_property = [RiCal::PropertyValue::Period.convert(self, ruby_value)]
      end
freebusy_property() click to toggle source

return the the FREEBUSY property which will be an array of instances of RiCal::PropertyValuePeriod

[purpose (from RFC 2445)] This property defines one or more free or busy time intervals.

see RFC 2445 4.8.2.6 pp 95-96

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

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

# File lib/ri_cal/properties/freebusy.rb, line 413
      def freebusy_property=(*property_values)
        @freebusy_property= property_values
      end
freebusys=(ruby_values) click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 419
      def freebusys=(ruby_values)
        @freebusy_property = ruby_values.map {|val| RiCal::PropertyValue::Period.convert(self, val)}
      end
organizer() click to toggle source

return the value of the ORGANIZER property which will be an instance of CalAddress

# File lib/ri_cal/properties/freebusy.rb, line 199
      def organizer
        organizer_property ? organizer_property.ruby_value : nil
      end
organizer=(ruby_value) click to toggle source

set the value of the ORGANIZER property

# File lib/ri_cal/properties/freebusy.rb, line 193
      def organizer=(ruby_value)
        self.organizer_property= RiCal::PropertyValue::CalAddress.convert(self, ruby_value)
      end
organizer_property() click to toggle source

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

[purpose (from RFC 2445)] The property defines the organizer for a calendar component.

see RFC 2445 4.8.4.3 pp 106-107

# File lib/ri_cal/properties/freebusy.rb, line 182
      def organizer_property
        @organizer_property
      end
organizer_property=(property_value) click to toggle source

set the ORGANIZER property property value should be an instance of RiCal::PropertyValueCalAddress

# File lib/ri_cal/properties/freebusy.rb, line 188
      def organizer_property=(property_value)
        @organizer_property = property_value
      end
remove_attendee(ruby_value) click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 323
      def  remove_attendee(ruby_value)
       self.attendee_property.delete(RiCal::PropertyValue::CalAddress.convert(self, ruby_value))
      end
remove_attendees(*ruby_values) click to toggle source

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/freebusy.rb, line 317
      def  remove_attendees(*ruby_values)
       ruby_values.each {|val|  self.attendee_property.delete(RiCal::PropertyValue::CalAddress.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/freebusy.rb, line 386
      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/freebusy.rb, line 380
      def  remove_comments(*ruby_values)
       ruby_values.each {|val|  self.comment_property.delete(RiCal::PropertyValue::Text.convert(self, val))}
      end
remove_freebusy(ruby_value) click to toggle source

remove one value from the FREEBUSY property one instances of Period may be passed to this method

# File lib/ri_cal/properties/freebusy.rb, line 449
      def  remove_freebusy(ruby_value)
       self.freebusy_property.delete(RiCal::PropertyValue::Period.convert(self, ruby_value))
      end
remove_freebusys(*ruby_values) click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 443
      def  remove_freebusys(*ruby_values)
       ruby_values.each {|val|  self.freebusy_property.delete(RiCal::PropertyValue::Period.convert(self, val))}
      end
remove_request_status(ruby_value) click to toggle source

remove one value from the REQUEST-STATUS property one instances of String may be passed to this method

# File lib/ri_cal/properties/freebusy.rb, line 509
      def  remove_request_status(ruby_value)
       self.request_status_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value))
      end
remove_request_statuses(*ruby_values) click to toggle source

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/freebusy.rb, line 503
      def  remove_request_statuses(*ruby_values)
       ruby_values.each {|val|  self.request_status_property.delete(RiCal::PropertyValue::Text.convert(self, val))}
      end
request_status() click to toggle source

return the value of the REQUEST-STATUS property which will be an array of instances of String

# File lib/ri_cal/properties/freebusy.rb, line 515
      def request_status
        request_status_property.map {|prop| prop ? prop.ruby_value : prop}
      end
request_status=(ruby_value) click to toggle source

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

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/freebusy.rb, line 467
      def request_status_property
        @request_status_property ||= []
      end
request_status_property=(*property_values) click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 473
      def request_status_property=(*property_values)
        @request_status_property= property_values
      end
request_statuses=(ruby_values) click to toggle source

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/freebusy.rb, line 479
      def request_statuses=(ruby_values)
        @request_status_property = ruby_values.map {|val| RiCal::PropertyValue::Text.convert(self, val)}
      end
uid() click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 232
      def uid
        uid_property ? uid_property.ruby_value : nil
      end
uid=(ruby_value) click to toggle source

set the value of the UID property

# File lib/ri_cal/properties/freebusy.rb, line 226
      def uid=(ruby_value)
        self.uid_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
      end
uid_property() click to toggle source

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

[purpose (from RFC 2445)] 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/freebusy.rb, line 215
      def uid_property
        @uid_property
      end
uid_property=(property_value) click to toggle source

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

# File lib/ri_cal/properties/freebusy.rb, line 221
      def uid_property=(property_value)
        @uid_property = property_value
      end
url() click to toggle source

return the value of the URL property which will be an instance of Uri

# File lib/ri_cal/properties/freebusy.rb, line 265
      def url
        url_property ? url_property.ruby_value : nil
      end
url=(ruby_value) click to toggle source

set the value of the URL property

# File lib/ri_cal/properties/freebusy.rb, line 259
      def url=(ruby_value)
        self.url_property= RiCal::PropertyValue::Uri.convert(self, ruby_value)
      end
url_property() click to toggle source

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

[purpose (from RFC 2445)] 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/freebusy.rb, line 248
      def url_property
        @url_property
      end
url_property=(property_value) click to toggle source

set the URL property property value should be an instance of RiCal::PropertyValueUri

# File lib/ri_cal/properties/freebusy.rb, line 254
      def url_property=(property_value)
        @url_property = property_value
      end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.