TimezoneDSTStart Property

The effective onset date and local time for the daylight-time time zone definition.

Syntax

 caldav.getTimezoneDSTStart([callback])
 caldav.setTimezoneDSTStart( timezoneDSTStart, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getTimezoneDSTStart([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setTimezoneDSTStart([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The effective onset date and local time for the daylight-time time zone definition. The date and time MUST be specified as a date with a local time value in the format "YYYYMMDDThhmmss", where "T" indicates the break between date and time.

TimezoneDSTStart, TimezoneDSTOffsetFrom, and TimezoneDSTOffsetTo are all required to specify the daylight-savings time zone.

The following example shows the CalTimezone set to Eastern time.

  CalDAV.Timezone.TimezoneId      = "US-Eastern";
  CalDAV.Timezone.URL             = "http://zones.example.com/tz/America-New_York.ics"

  CalDAV.Timezone.StdName         = "Eastern Standard Time (US & Canada)";
  CalDAV.Timezone.StdStart        = "20071104T020000";
  CalDAV.Timezone.StdOffsetFrom   = "-400";
  CalDAV.Timezone.StdOffsetTo     = "-500";
  CalDAV.Timezone.StdRule         = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11";

  CalDAV.TimeZone.DSTName         = "Eastern Daylight Time (US & Canada)";
  CalDAV.TimeZone.DSTStart        = "20070311T020000";  
  CalDAV.TimeZone.DSTOffsetFrom   = "-500";
  CalDAV.TimeZone.DSTOffsetTo     = "-400";
  CalDAV.TimeZone.DSTRule         = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";

Data Type

String