TimeZoneDatabase

baja. TimeZoneDatabase

new TimeZoneDatabase()

Description:

  • Queries the time zone database from the station.

    There is no reason to call this constructor directly; rather use the
    static accessor functions.

Source:

Methods

getAllSupportedZoneIds() → {Array.<String>}

Description:

  • Return all time zone IDs the station knows about.

Source:
Returns:
Type
Array.<String>

getLocalTimeZone() → {baja.TimeZone}

Description:

  • Return the location based TimeZone value.

Source:
Since:
  • Niagara 4.14
Returns:
Type
baja.TimeZone

getTimeZone(id) → {baja.TimeZone}

Description:

  • Return the TimeZone instance corresponding to the given ID.

Source:
Parameters:
Name Type Description
id String
Returns:

the time zone, or null if not found

Type
baja.TimeZone

getTimeZones() → {Array.<baja.TimeZone>}

Description:

  • Return all TimeZone instances the station knows about.

Source:
Returns:
Type
Array.<baja.TimeZone>

isZoneIdSupported(id) → {boolean}

Description:

  • Return true if the station knows about the given time zone ID.

Source:
Parameters:
Name Type Description
id string
Returns:
Type
boolean

(static) get(callbacks) → {Promise}

Description:

  • Asynchronously retrieve the time zone database from the station. The
    network call to the station will only happen once: the same database
    instance will be resolved no matter how many times this function is called.

Source:
Parameters:
Name Type Description
callbacks Object
Properties
Name Type Attributes Description
ok function

ok callback, will receive a
TimeZoneDatabase instance populated with data retrieved from the station
fail function

fail callback
batch baja.comm.Batch <optional>

batch to use for the network
request
Returns:
Type
Promise