TimezoneStdOffsetTo Property

The UTC offset for standard time, when this observance is in use.

Syntax

 caldav.getTimezoneStdOffsetTo([callback])
 caldav.setTimezoneStdOffsetTo( timezoneStdOffsetTo, [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 getTimezoneStdOffsetTo([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 setTimezoneStdOffsetTo([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 UTC offset for standard time, when this observance is in use.

TimezoneStdStart, TimezoneStdOffsetFrom, and TimezoneStdOffsetTo are all required to specify the standard-time 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