Home > @magiclane/maps-sdk > TimezoneService

TimezoneService class

Timezone Service class

Provides information about timezones.

Core

Signature:

export declare class TimezoneService 

Methods

Method

Modifiers

Description

getTimezoneInfoFromCoordinates(params)

static

Async gets timezone info based on a coordinate and a timestamp

**Parameters**

* **IN** *coords* The location from where to get the timezone result * **IN** *time* The time for which offsets are calculated (UTC) * **IN** *accurateResult* If left 'false' the result will be computed using the available offline resource. If 'true' an HTTP request will be performed for computing the result * **IN** *onComplete* The callback which will be called when the operation completes. * Will be called with GemError.success error and non-null result upon success. * Will be called with GemError.internalAbort error and null result if the result parsing failed or server internal error occurred

**Returns**

* EventDrivenProgressListener for the operation progress if the operation could be started, null otherwise

**Throws**

* An exception if it fails.

getTimezoneInfoFromCoordinatesSync(params)

static

Synchronously gets timezone info based on a coordinate and a timestamp

**Parameters**

* **IN** *coords* The location from where to get the timezone result * **IN** *time* The time for which offsets are calculated (UTC)

**Returns**

* A TimezoneResult if the operation was successful, null otherwise

**Throws**

* An exception if it fails.

getTimezoneInfoFromTimezoneId(params)

static

Async gets timezone info based on a timezone id and a timestamp

**Parameters**

* **IN** *timezoneId* The geographic location on earth of type: "Continent/City". Examples: Europe/Paris, America/New_York, Europe/Moscow * **IN** *time* The time for which offsets are calculated (UTC) * **IN** *accurateResult* If left 'false' the result will be computed using the available offline resource. If 'true' an HTTP request will be performed for computing the result * **IN** *onComplete* The callback which will be called when the operation completes. * Will be called with GemError.success error and non-null result upon success. * Will be called with GemError.internalAbort error and null result if the result parsing failed or server internal error occurred

**Returns**

* EventDrivenProgressListener for the operation progress if the operation could be started, null otherwise

**Throws**

* An exception if it fails.

getTimezoneInfoTimezoneIdSync(params)

static

Synchronously gets timezone info based on a timezone ID and a timestamp

**Parameters**

* **IN** *timezoneId* The IANA timezone identifier (e.g., "America/New_York") for which the timezone result is requested * **IN** *time* The time for which offsets are calculated (UTC)

**Returns**

* A TimezoneResult if the operation was successful, null otherwise

**Throws**

* An exception if it fails.