Class RiCal::PropertyValue::DateTime
In: lib/ri_cal/property_value/date_time/timezone_support.rb
lib/ri_cal/property_value/date_time/time_machine.rb
lib/ri_cal/property_value/date_time/additive_methods.rb
lib/ri_cal/property_value/date_time.rb
Parent: Object
  • ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
 RiCal::PropertyValue::CalAddress represents an icalendar CalAddress property value
 which is defined in RFC 2445 section 4.3.5 pp 35-37

Methods

Included Modules

Comparable AdditiveMethods TimezoneSupport TimeMachine

Classes and Modules

Module RiCal::PropertyValue::DateTime::AdditiveMethods
Module RiCal::PropertyValue::DateTime::TimeMachine
Module RiCal::PropertyValue::DateTime::TimezoneSupport

External Aliases

to_datetime -> to_ri_cal_ruby_value

Public Class methods

Set the default tzid to be used when instantiating an instance from a ruby object see RiCal::PropertyValue::DateTime.from_time

The parameter tzid is a string value to be used for the default tzid, a value of :floating will cause values with NO timezone to be produced, which will be interpreted by iCalendar as floating times i.e. they are interpreted in the timezone of each client. Floating times are typically used to represent events which are ‘repeated’ in the various time zones, like the first hour of the year.

Extract the time and timezone identifier from an object used to set the value of a DATETIME property.

If the object is a string it should be of the form [TZID=identifier:]

Otherwise determine if the object acts like an activesupport enhanced time, and extract its timezone idenfifier if it has one.

Public Instance methods

Compare the receiver with another object which must respond to the to_datetime message The comparison is done using the Ruby DateTime representations of the two objects

Determine if the receiver and another object are equivalent RiCal::PropertyValue::DateTime instances

Return the day of the month

Return the number of days in the month containing the receiver

Return the hour

Determine if the receiver and other are in the same month

mday()

Alias for day

Return the minute

Return the month of the year (1..12)

Return a Hash representing this properties parameters

Returns a ruby DateTime object representing the receiver.

Return the second

to_finish_time()

Alias for ruby_value

If a time is floating, then the utc of it‘s start time may actually be as early as 12 hours later if the occurrence is being viewed in a time zone just east of the International Date Line

If a time is floating, then the utc of it‘s start time may actually be as early as 12 hours earlier if the occurrence is being viewed in a time zone just west of the International Date Line

Returns the value of the receiver as an RFC 2445 iCalendar string

Return the day of the week

Return the year (including the century)

[Validate]