dstOffset
Syntax
$calendar.dstOffset()
Description
Specifies the DST (Daylight Saving Time) offset, i.e. the difference of the time to UTC during daylight saving time. The specification is in milliseconds.
Parameter
Name | Type | Description | Mandatory | Default |
---|---|---|---|---|
calendar | Business object | The calendar whose DST offset is to be determined. This can be a system or user calendar. | yes |
Return value
Type: Number
The DST offset to UTC time at the time of the calendar date.
Examples
Daylight saving time
date(2012, 6, 15).toUserCalendar().dstOffset()
Output in European time zone (UTC +1): 3600000
At this time, daylight saving time applies in the time zone, hence a DST offset of 1 hour.
Winter time
date(2012, 1, 15).toUserCalendar().dstOffset()
Output in European Time Zone (UTC +1): 0
At this time, daylight saving time does not apply in the time zone, therefore the DST offset is 0.