TimeZone

baja. TimeZone

new TimeZone()

Description:

  • Represents a baja:TimeZone in BajaScript.

Source:

Extends

Members

(static) DEFAULT :baja.TimeZone

Source:
Type:

(static) GMT :baja.TimeZone

Source:
Type:

(static) NULL :baja.TimeZone

Source:
Type:

(static) UTC :baja.TimeZone

Source:
Type:

Methods

decodeAsync(str, batchopt) → {baja.Simple|Promise.<baja.Simple>}

Description:

  • The string encoding of certain Simples may include Type information, or other data that may
    require asynchronous operations to decode. For instance, some Simples may function as
    "containers" for other Simples, and may include that Type information in the string encoding.
    That Simple would then need to import those Types before it could be fully decoded in the
    browser.

    baja.Facets is a great example of this. A Facets may contain FrozenEnum values that are
    defined by Types, such as baja:Weekday. For a Facets containing a Weekday to be fully
    constructed in the browser, the baja:Weekday Type must be imported first. Since importing
    a Type may require a network call, this Facets instance might not be able to be constructed
    synchronously, using only decodeFromString(). baja.Facets has itself implemented
    decodeAsync() to import any necessary Types.

    When implementing a Type Extension for a Simple, if your Simple references arbitrary Types that
    need to be imported when decoding your Simple, implement decodeAsync() and perform any Type
    imports (or other asynchronous operations) there.

    If you are writing code that decodes Simples from strings - that is, when you have a type spec
    and string encoding, and you need to be able to decode any kind of Simple - favor the use of
    decodeAsync, as it gives the individual Simple a chance to perform async operations to ensure
    that the decoded Simple is fully correct.

    The default implementation just returns decodeFromString directly.

    Prior to Niagara 4.14, decodeAsync() was only used in field editors. In 4.14 and later,
    decodeAsync() will be used by BajaScript itself to support asynchronous decoding of Simples
    when resolving ORDs and retrieving other data from the station.

    (Note: decodeAsync() cannot be used by the framework to decode frozen slots. If you
    have a frozen slot, whose definition is a Simple that would require the use of
    decodeAsync() to construct it, it will not work. The best approach would be to implement a
    Type Extension that would use the baja! plugin to preload all the types referenced by the
    default value of that frozen slot, so that decodeFromString would have all the information
    it needed to construct it synchronously.)

Source:
Inherited From:
Example
return Promise.resolve(baja.$(simpleTypeSpec).decodeAsync(stringEncoding))
  .then((simpleInstance) => {});
Parameters:
Name Type Attributes Description
str string
batch baja.comm.Batch <optional>

optional batch to use
Returns:

may return the Simple instance
directly, or a Promise resolving to same - so wrap in Promise.resolve()
if unsure.

Type
baja.Simple | Promise.<baja.Simple>

decodeFromString(str) → {baja.TimeZone}

Description:

  • Decode a baja:TimeZone instance from the given string.

Source:
Overrides:
Parameters:
Name Type Description
str string
Returns:
Type
baja.TimeZone

encodeToString() → {string}

Description:

  • Encode this baja:TimeZone instance to a string.

Source:
Overrides:
Returns:
Type
string

equals(obj) → {Boolean}

Description:

  • Equality test.

Source:
Inherited From:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

equivalent(obj) → {Boolean}

Description:

  • Equivalence test.

    equivalent() is used to compare if two Objects have equivalent
    state, but might not want to return true for equals since it
    it has implied semantics for many operations. The default
    implementation returns the result of baja.Object#equals.

Source:
Inherited From:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

getAgents(isopt, batchopt) → {Promise}

Description:

  • Returns a promise that resolves to the agent list for this Object.

Source:
Inherited From:
See:
Parameters:
Name Type Attributes Description
is Array.<String> <optional>

An optional array of filters to add to the
agent query.
batch baja.comm.Batch <optional>

An optional object used to batch network
calls together.
Returns:

A promise that will resolve with the Agent Info.

Type
Promise

getDaylightAdjustment() → {number}

Description:

  • Return the DST adjustment, in milliseconds.

Source:
Returns:
Type
number

getDisplayName(dstopt) → {string}

Description:

  • Get the display name for this time zone.

Source:
Parameters:
Name Type Attributes Description
dst boolean <optional>

whether DST should be considered active when getting
the display name. If omitted, the method will consider whether DST is
active at the present moment.
Returns:
Type
string

getIcon() → {baja.Icon}

Description:

  • Return the Object's Icon.

Source:
Inherited From:
Returns:
Type
baja.Icon

getId() → {string}

Description:

  • Get the time zone ID.

Source:
Returns:
Type
string

getShortDisplayName(dstopt) → {string}

Description:

  • Get the short display name for this time zone.

Source:
Parameters:
Name Type Attributes Description
dst boolean <optional>

whether DST should be considered active when getting
the short display name. If omitted, the method will consider whether DST is
active at the present moment.
Returns:
Type
string

getType() → {Type}

Description:

  • Get the type of this instance.

Source:
Inherited From:
Returns:
Type
Type

getTypeDisplayName(cxopt) → {Promise.<string>|string}

Description:

  • Gets the friendly type display name for this object.

Source:
Since:
  • Niagara 4.10
Inherited From:
See:
  • baja.Type#getDisplayName
Parameters:
Name Type Attributes Description
cx Object <optional>

a context to be passed down to Type
Returns:

If no context is provided, the type
display name is returned synchronously as a string. If context provided,
the type display name is resolved via a promise as a string.

Type
Promise.<string> | string

getUtcOffset() → {number}

Description:

  • Get the UTC offset in milliseconds.

Source:
Returns:
Type
number

make()

Source:
Overrides:
See:
  • .make

newCopy(exactopt)

Description:

  • Every value may be cloned using the newCopy method.

    Please note that Simples are immutable so they don't
    allocate a new instance.

Source:
Inherited From:
See:
Parameters:
Name Type Attributes Description
exact Boolean <optional>

true if an exact copy of the value should be
made (only valid in the Component architecture).
Returns:

a copy of the value (or the same instance if the value is a
Simple).

toString(cxopt) → {String|Promise.<String>}

Description:

  • Returns the String representation of this object.

Source:
Overrides:
See:
Parameters:
Name Type Attributes Description
cx Object <optional>

optional context information to be used when
formatting the string
Returns:

a string (if no context passed), or
either a string or a Promise (if context passed).

Type
String | Promise.<String>

valueOf() → {String}

Source:
Inherited From:
Returns:

the string encoding of the Simple, by default

Type
String

(static) isDstActive(dopt, timeZoneopt) → {boolean}

Description:

  • Return true if daylight savings time is active for the given date.
    Note: If no timezone is provided, this will not use timezone rules, rather
    a simplistic method of comparing offsets in January and June for the local
    browser.

    If a timezone is provided, daylights savings will be determined at the
    given date in that timezone.

    Please note: javascript dates will always have a local timezone
    offset. The underlying milliseconds from epoch value will be used as the
    source of truth for the time. This point in time will then be used to
    determine whether daylight savings is active at that underlying millisecond
    value in the given timezone (if provided).

Source:
Parameters:
Name Type Attributes Description
d Date <optional>

the date to check. If omitted, the current date will be
checked.
timeZone baja.TimeZone <optional>

the timezone to use.
Returns:

true if daylight savings time is active

Type
boolean

(static) make(id, utcOffsetopt, dstOffsetopt, startRuleopt, endRuleopt, paramsopt)

Description:

  • Make a new baja:TimeZone instance.

    There is not usually a reason, nor a good way, to create time zones
    directly in BajaScript: you will most likely want to use the time zones
    returned from the station, using the TimeZoneDatabase.

Source:
Parameters:
Name Type Attributes Default Description
id string
utcOffset number <optional>
 0

UTC offset in milliseconds
dstOffset number <optional>
 0

DST offset in milliseconds
startRule string <optional>
 null

daylight savings start rule, encoded as a
string. This can be specific to the JVM. null is an acceptable value.
endRule string <optional>
 null

daylight savings end rule - same caveats as
startRule
params Object <optional>
Properties
Name Type Attributes Description
displayName string <optional>

long display name, when DST is
inactive
dstDisplayName string <optional>

long display name, when DST is
active
shortDisplayName string <optional>

short display name, when DST is
inactive
shortDstDisplayName string <optional>

short display name, when DST
is active