Plugin API » Interfaces » TimeZone

TimeZone interface

A JavaScript object implementing the TimeZone interface provides information about a time zone.

Construction

Use O.timeZone(), or call getTimeZone() on a SecurityPrincipal.

Interface

property id

The time zone id, for example, "Europe/Londond".

property displayName

The name of the time zone suitable for display to the user.

function getOffset(date)

Returns the offset of the time zone, in milliseconds, on the given date.

If the optional date argument is not used or is null, this function will return the offset at the current time.