Module RiCal::Properties::Todo
In: lib/ri_cal/properties/todo.rb
  • ©2009 Rick DeNatale
  • All rights reserved. Refer to the file README.txt for the license
 Properties::Todo provides property accessing methods for the Todo class
 This source file is generated by the  rical:gen_propmodules rake tasks, DO NOT EDIT

Methods

add_attach   add_attachments   add_attendee   add_attendees   add_categories   add_comment   add_comments   add_contact   add_contacts   add_exdate   add_exdates   add_exrule   add_exrules   add_multiple_categories   add_multiple_related_to   add_multiple_resources   add_rdate   add_rdates   add_related_to   add_request_status   add_request_statuses   add_resources   add_rrule   add_rrules   attach   attach=   attach_property   attach_property=   attachments=   attendee   attendee=   attendee_property   attendee_property=   attendees=   categories   categories=   categories_property   categories_property=   class_property   class_property=   comment   comment=   comment_property   comment_property=   comments=   completed   completed=   completed_property   completed_property=   contact   contact=   contact_property   contact_property=   contacts=   created   created=   created_property   created_property=   description   description=   description_property   description_property=   dtstamp   dtstamp=   dtstamp_property   dtstamp_property=   dtstart   dtstart=   dtstart_property   dtstart_property=   due   due=   due_property   due_property=   duration   duration=   duration_property   duration_property=   exdate   exdate=   exdate_property   exdate_property=   exdates=   exrule   exrule=   exrule_property   exrule_property=   exrules=   geo   geo=   geo_property   geo_property=   last_modified   last_modified=   last_modified_property   last_modified_property=   location   location=   location_property   location_property=   multiple_categories=   multiple_related_to=   multiple_resources=   organizer   organizer=   organizer_property   organizer_property=   percent_complete   percent_complete=   percent_complete_property   percent_complete_property=   priority   priority=   priority_property   priority_property=   rdate   rdate=   rdate_property   rdate_property=   rdates=   recurrence_id   recurrence_id=   recurrence_id_property   recurrence_id_property=   related_to   related_to=   related_to_property   related_to_property=   remove_attach   remove_attachments   remove_attendee   remove_attendees   remove_categories   remove_comment   remove_comments   remove_contact   remove_contacts   remove_exdate   remove_exdates   remove_exrule   remove_exrules   remove_multiple_categories   remove_multiple_related_to   remove_multiple_resources   remove_rdate   remove_rdates   remove_related_to   remove_request_status   remove_request_statuses   remove_resources   remove_rrule   remove_rrules   request_status   request_status=   request_status_property   request_status_property=   request_statuses=   resources   resources=   resources_property   resources_property=   rrule   rrule=   rrule_property   rrule_property=   rrules=   security_class   security_class=   sequence   sequence=   sequence_property   sequence_property=   status   status=   status_property   status_property=   summary   summary=   summary_property   summary_property=   uid   uid=   uid_property   uid_property=   url   url=   url_property   url_property=  

Public Instance methods

add one value to the ATTACH property one instances of Uri may be passed to this method

add one or more values to the ATTACH property one or more instances of Uri may be passed to this method

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

add one or more values to the ATTENDEE property one or more instances of CalAddress may be passed to this method

add one value to the CATEGORIES property one instances of Array may be passed to this method

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

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

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

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

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

add one or more values to the EXDATE property one or more instances of OccurrenceList may be passed to this method

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

add one or more values to the EXRULE property one or more instances of RecurrenceRule may be passed to this method

add one or more values to the CATEGORIES property one or more instances of Array may be passed to this method

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

add one or more values to the RESOURCES property one or more instances of Array may be passed to this method

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

add one or more values to the RDATE property one or more instances of OccurrenceList may be passed to this method

add one value to the RELATED-TO property one instances of String may be passed to this method

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

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

add one value to the RESOURCES property one instances of Array may be passed to this method

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

add one or more values to the RRULE property one or more instances of RecurrenceRule may be passed to this method

return the value of the ATTACH property which will be an array of instances of Uri

set the value of the ATTACH property to a single value one instance of Uri may be passed to this method

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

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

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

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

set the value of the ATTENDEE property to a single value one instance of CalAddress may be passed to this method

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

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

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

return the value of the CATEGORIES property which will be an array of instances of Array

set the value of the CATEGORIES property to a single value one instance of Array may be passed to this method

return the the CATEGORIES property which will be an array of instances of RiCal::PropertyValueArray

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

see RFC 2445 4.8.1.2 pp 78-79

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

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

[purpose (from RFC 2445)] This property defines the access classification for a calendar component.

see RFC 2445 4.8.1.3 pp 79-80

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

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

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

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

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

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

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

set the value of the COMPLETED property

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

[purpose (from RFC 2445)] This property specifies the date and time that a to-do was actually completed.

see RFC 2445 4.8.2.1 pp 90-91

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

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

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

return the the CONTACT property which will be an array of 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

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

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

return the value of the CREATED property which will be an instance of ZuluDateTime

set the value of the CREATED property

return the the CREATED property which will be an instances of RiCal::PropertyValueZuluDateTime

[purpose (from RFC 2445)] 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

set the CREATED property property value should be an instance of RiCal::PropertyValueZuluDateTime

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

set the value of the DESCRIPTION property

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

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

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

set the value of the DTSTAMP property

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

[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

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

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

set the value of the DTSTART property

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

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

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

set the value of the DUE property

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

[purpose (from RFC 2445)] This property defines the date and time that a to-do is expected to be completed.

see RFC 2445 4.8.2.3 pp 92-93

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

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

set the value of the DURATION property

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

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

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

set the value of the EXDATE property to a single value one instance of OccurrenceList may be passed to this method

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

[purpose (from RFC 2445)] This property defines the list of date/time exceptions for a recurring calendar component.

see RFC 2445 4.8.5.1 pp 112-114

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

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

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

set the value of the EXRULE property to a single value one instance of RecurrenceRule may be passed to this method

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

[purpose (from RFC 2445)] 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

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

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

return the value of the GEO property which will be an instance of Geo

set the value of the GEO property

return the the GEO property which will be an instances of RiCal::PropertyValueGeo

[purpose (from RFC 2445)] 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

set the GEO property property value should be an instance of RiCal::PropertyValueGeo

return the value of the LAST-MODIFIED property which will be an instance of ZuluDateTime

set the value of the LAST-MODIFIED property

return the the LAST-MODIFIED property which will be an instances of RiCal::PropertyValueZuluDateTime

[purpose (from RFC 2445)] 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

set the LAST-MODIFIED property property value should be an instance of RiCal::PropertyValueZuluDateTime

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

set the value of the LOCATION property

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

[purpose (from RFC 2445)] This property defines the intended venue for the activity defined by a calendar component.

see RFC 2445 4.8.1.7 pp 84

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

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

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

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

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

set the value of the ORGANIZER property

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

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

return the value of the PERCENT-COMPLETE property which will be an instance of Integer

set the value of the PERCENT-COMPLETE property

return the the PERCENT-COMPLETE property which will be an instances of RiCal::PropertyValueInteger

[purpose (from RFC 2445)] This property is used by an assignee or delegatee of a to-do to convey the percent completion of a to-do to the Organizer.

see RFC 2445 4.8.1.8 pp 85

set the PERCENT-COMPLETE property property value should be an instance of RiCal::PropertyValueInteger

return the value of the PRIORITY property which will be an instance of Integer

set the value of the PRIORITY property

return the the PRIORITY property which will be an instances of RiCal::PropertyValueInteger

[purpose (from RFC 2445)] This property defines the relative priority for a calendar component.

see RFC 2445 4.8.1.9 pp 85-87

set the PRIORITY property property value should be an instance of RiCal::PropertyValueInteger

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

set the value of the RDATE property to a single value one instance of OccurrenceList may be passed to this method

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

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

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

return the value of the RECURRENCE-ID property which will be an instance of either DateTime or Date

set the value of the RECURRENCE-ID property

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

[purpose (from RFC 2445)] 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

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

return the value of the RELATED-TO property which will be an array of instances of String

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

return the the RELATED-TO property which will be an array of instances of RiCal::PropertyValueText

[purpose (from RFC 2445)] The property is used to represent a relationship or reference between one calendar component and another.

see RFC 2445 4.8.4.5 pp 109-110

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

remove one value from the ATTACH property one instances of Uri may be passed to this method

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

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

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

remove one value from the CATEGORIES property one instances of Array may be passed to this method

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

remove one value from the RESOURCES property one instances of Array may be passed to this method

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

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

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

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

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

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

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

return the value of the RESOURCES property which will be an array of instances of Array

set the value of the RESOURCES property to a single value one instance of Array may be passed to this method

return the the RESOURCES property which will be an array of instances of RiCal::PropertyValueArray

[purpose (from RFC 2445)] 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

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

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

set the value of the RRULE property to a single value one instance of RecurrenceRule may be passed to this method

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

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

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

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

set the value of the CLASS property

return the value of the SEQUENCE property which will be an instance of Integer

set the value of the SEQUENCE property

return the the SEQUENCE property which will be an instances of RiCal::PropertyValueInteger

[purpose (from RFC 2445)] 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

set the SEQUENCE property property value should be an instance of RiCal::PropertyValueInteger

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

set the value of the STATUS property

return the the STATUS 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.11 pp 80-89

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

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

set the value of the SUMMARY property

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

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

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

set the value of the UID property

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

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

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

set the value of the URL property

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

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

[Validate]