Skip to content

Latest commit

 

History

History
63 lines (35 loc) · 2.82 KB

dateTimeValue.md

File metadata and controls

63 lines (35 loc) · 2.82 KB

vobject.dateTimeValue(dateTimeString='') RFC

This is a DATE-TIME value type to represent a calendar date and time as a value of a property. The object methods closely resembles the dateValue object.

  • dateTimeString is an optional constructor date time string parameter in the format YYYY-MM-DDTHH:mm:ssZ. If omitted, the dateTimeValue is defaulted to the current date and time.

Usage:

var dateTimeValue = vobject.dateTimeValue('2013-08-13T17:33:40-04:00');
dateTimeValue.toICS(); // 20130813T213340Z

var dateTimeValue = vobject.dateTimeValue('2013-08-13T17:33:40-04:00');
dateTimeValue.setTZID('America/New_York');
dateTimeValue.toICS(); // 20130813173340

which translates to August 13th, 2013 - 9:33:40pm UTC

dateTimeValue.type = 'dateTimeValue'

Type definition of the value. Useful when used in conjunction with properties.

dateTimeValue.parseDateTime(dateTimeString)
  • dateTimeString to parse. Expects the format YYYY-MM-DDTHH:mm:ssZ. Ex: 2013-08-13T17:33:40-04:00
dateTimeValue.toDateTime()
  • returns rendered date time string representation of the DATE-TIME value type with the UTC offset. Ex: 2013-08-13T21:33:40+00:00
dateTimeValue.parseTimestamp(timestamp)
  • timestamp to parse defined as seconds since UNIX epoch. Expects an INTEGER
dateTimeValue.toTimestamp();
  • returns string representation of timestamp as seconds since UNIX epoch
dateTimeValue.setTZID(tzid)
  • tzid to set for the date time value. Expects a TZID string. Ex: America/New_York, Europe/Paris
dateTimeValue.getTZID()
  • returns the tzid set for the date time value. Will only work if a time zone name is explicited defined. Date offsets (-04:00) do not have enough information to derive a time zone.
dateTimeValue.parseICS(ics, tz = UTC)
  • ics string to parse. Expects the absolute format YYYYMMDDTHHmmssZ or floating format YYYYMMDDTHHmmss and a time zone. Ex: 20130823T213340Z, 20130823T173340, America/New_York
dateTimeValue.toICS()
  • returns rendered iCalendar string representation of the DATE-TIME value type. If a time zone is set for the value, this will return a floating representation in the format YYYYMMDDTHHmmss. Otherwise it will return a UTC representation in the format YYYYMMDDTHHmmssZ