goog.i18n.TimeZone

Provided By	`goog.i18n.TimeZone`

TimeZone class implemented a time zone resolution and name information source for client applications. The time zone object is initiated from a time zone information object. Application can initiate a time zone statically, or it may choose to initiate from a data obtained from server. Each time zone information array is small, but the whole set of data is too much for client application to download. If end user is allowed to change time zone setting, dynamic retrieval should be the method to use. In case only time zone offset is known, there is a decent fallback that only use the time zone offset to create a TimeZone object.

new TimeZone()

Parameters	None.

VIEW SOURCE

Instance Methods

Return the DST adjustment to the time zone offset for a given time. While Daylight Saving Time is in effect, this number is positive. Otherwise, it is zero.

Parameters

`date`	`(Date\|goog.date.Date\|null)`
	The time to check.

Returns

number

The DST adjustment in minutes EAST of UTC.

VIEW SOURCE

Return the GMT representation of this time zone object.

Parameters

`date`	`(Date\|goog.date.Date\|null)`
	The date for which time to retrieve GMT string.

Returns

string

GMT representation string.

VIEW SOURCE

Get the generic location time zone name for a given date/time.

Parameters

`date`	`(Date\|goog.date.Date)`
	The time for which to retrieve the generic location time zone name.

Returns

string

The generic location time zone name.

VIEW SOURCE

Get the long time zone name for a given date/time.

Parameters

`date`	`(Date\|goog.date.Date\|null)`
	The time for which to retrieve the long time zone name.

Returns

string

The long time zone name.

VIEW SOURCE

Get the long GMT time zone name for a given date/time.

Parameters

`date`	`(Date\|goog.date.Date)`
	The time for which to retrieve the long GMT time zone name.

Returns

string

The long GMT time zone name.

VIEW SOURCE

Get the time zone offset in minutes WEST of UTC for a given date/time.

Parameters

`date`	`(Date\|goog.date.Date\|null)`
	The time for which to retrieve the time zone offset.

Returns

number

The time zone offset in minutes WEST of UTC.

VIEW SOURCE

Get the RFC representation of the time zone for a given date/time.

Parameters

`date`	`(Date\|goog.date.Date\|null)`
	The time for which to retrieve the RFC time zone string.

Returns

string

The RFC time zone string.

VIEW SOURCE

Get the short time zone name for given date/time.

Parameters

`date`	`(Date\|goog.date.Date\|null)`
	The time for which to retrieve the short time zone name.

Returns

string

The short time zone name.

VIEW SOURCE

Convert the contents of time zone object to a timeZoneData object, suitable for passing to goog.i18n.TimeZone.createTimeZone.

Parameters

None.

Returns

Object

A timeZoneData object (see the documentation for goog.i18n.TimeZone.createTimeZone).

VIEW SOURCE

Return the time zone ID for this time zone.

Parameters

None.

Returns

string

The time zone ID.

VIEW SOURCE

Return the UTC representation of this time zone object.

Parameters

`date`	`(Date\|goog.date.Date)`
	The date for which time to retrieve UTC string.

Returns

string

UTC representation string.

VIEW SOURCE

Check if Daylight Saving Time is in effect at a given time in this time zone.

Parameters

`date`	`(Date\|goog.date.Date\|null)`
	The time to check.

Returns

boolean

True if Daylight Saving Time is in effect.

VIEW SOURCE

Static Functions

This factory method creates a time zone instance. It takes either an object containing complete time zone information, or a single number representing a constant time zone offset. If the latter form is used, DST functionality is not available.

Parameters

timeZoneData (number|Object|null)

If this parameter is a number, it should indicate minutes WEST of UTC to be used as a constant time zone offset. Otherwise, it should be an object with these four fields:

id: A string ID for the time zone.
std_offset: The standard time zone offset in minutes EAST of UTC.
names: An array of four names (standard short name, standard long name, daylight short name, daylight long, name)
names_ext: A hash of four fields (standard long name gmt, daylight long name gmt, standard generic location, daylight generic location)
transitions: An array of numbers which are interpreted in pairs: [time1, adjustment1, time2, adjustment2, ...] where each time is a DST transition point given as a number of hours since 00:00 UTC, January 1, 1970, and each adjustment is the adjustment to apply for times after the DST transition, given as minutes EAST of UTC.

Returns

goog.i18n.TimeZone

A goog.i18n.TimeZone object for the given time zone data.

VIEW SOURCE

Enumerations

TimeZone.NameType

goog.i18n.TimeZone

new TimeZone()

Instance Methods

`this.`getDaylightAdjustment( `date` ) `→` `number`

`this.`getGMTString( `date` ) `→` `string`

`this.`getGenericLocation( `date` ) `→` `string`

`this.`getLongName( `date` ) `→` `string`

`this.`getLongNameGMT( `date` ) `→` `string`

`this.`getOffset( `date` ) `→` `number`

`this.`getRFCTimeZoneString( `date` ) `→` `string`

`this.`getShortName( `date` ) `→` `string`

`this.`getTimeZoneData() `→` `Object`

`this.`getTimeZoneId() `→` `string`

`this.`getUTCString( `date` ) `→` `string`

`this.`isDaylightTime( `date` ) `→` `boolean`

Static Functions

TimeZone.createTimeZone( `timeZoneData` ) `→` `goog.i18n.TimeZone`

Enumerations

goog.i18n.TimeZone

new TimeZone()

Instance Methods

this.getDaylightAdjustment( date ) → number

this.getGMTString( date ) → string

this.getGenericLocation( date ) → string

this.getLongName( date ) → string

this.getLongNameGMT( date ) → string

this.getOffset( date ) → number

this.getRFCTimeZoneString( date ) → string

this.getShortName( date ) → string

this.getTimeZoneData() → Object

this.getTimeZoneId() → string

this.getUTCString( date ) → string

this.isDaylightTime( date ) → boolean

Static Functions

TimeZone.createTimeZone( timeZoneData ) → goog.i18n.TimeZone

Enumerations

`this.`getDaylightAdjustment( `date` ) `→` `number`

`this.`getGMTString( `date` ) `→` `string`

`this.`getGenericLocation( `date` ) `→` `string`

`this.`getLongName( `date` ) `→` `string`

`this.`getLongNameGMT( `date` ) `→` `string`

`this.`getOffset( `date` ) `→` `number`

`this.`getRFCTimeZoneString( `date` ) `→` `string`

`this.`getShortName( `date` ) `→` `string`

`this.`getTimeZoneData() `→` `Object`

`this.`getTimeZoneId() `→` `string`

`this.`getUTCString( `date` ) `→` `string`

`this.`isDaylightTime( `date` ) `→` `boolean`

TimeZone.createTimeZone( `timeZoneData` ) `→` `goog.i18n.TimeZone`