TimezoneStdRule Property

This property defines the recurrence rule for the onset of this standard time observance.

Syntax

 caldav.getTimezoneStdRule([callback])
 caldav.setTimezoneStdRule( timezoneStdRule, [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 getTimezoneStdRule([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 setTimezoneStdRule([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

This property defines the recurrence rule for the onset of this standard time observance. Some specific requirements for the usage of TimezoneDSTRule for this purpose include:


FREQ	Frequency of the time zone onset. (Almost always "YEARLY")
BYMONTH	The month of the time zone onset.
BYDAY	The day of the time zone onset. Formatted as a number and a two-character day. "BYDAY=3SU" means the 3rd Sunday of the month. "BYDAY=-1SU" is the last Sunday of the month.
UNTIL	If the observance is known to have an effective end date, the "UNTIL" recurrence rule parameter MUST be used to specify the last valid onset of this observance (i.e., the UNTIL DATE-TIME will be equal to the last instance generated by the recurrence pattern). It MUST be specified in UTC time.

Note that the TimezoneStdStart and TimezoneStdOffsetFrom properties must be used when generating the onset DATE-TIME values (instances) from the TimezoneStdRule

For instance, in the USA Eastern Standard time before 2007 started on the last Sunday of October. In 2007 Standard time was changed to begin on the 1st Sunday in November. Therefore, the UNTIL option should indicate the LAST time this rule will be observed. (2am on October 29th, 2006). Such a time zone declaration would look like this:

	CalDAV.time zone.StdName = "EST"
	CalDAV.time zone.StdStart = "19671029T020000"
	CalDAV.time zone.StdOffsetFrom = "-400"
	CalDAV.time zone.StdOffsetTo = "-500"
	CalDAV.time zone.StdRule = "FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU;UNTIL=20061029T060000Z"

Data Type