Time

baja. Time

new Time()

Description:

  • Represents a baja:Time in BajaScript.

    Time stores a time of day which is independent
    of any date in the past or future.

    When creating a Simple, always use the make() method instead of
    creating a new Object.

Source:

Extends

Members

(static) DEFAULT :baja.Time

Description:

  • Default Time instance.

Source:

Default Time instance.

Type:

(static) MIDNIGHT :baja.Time

Description:

  • Midnight Time.

Source:

Midnight Time.

Type:

Methods

add(duration) → {baja.Time}

Description:

  • Return a new time of day by adding the specified duration. If the result
    goes past midnight, then roll into the next day.

Source:
Parameters:
Name Type Description
duration baja.RelTime | baja.Time | Number

RelTime or number of
millis
Returns:

the new time with the duration added on.

Type
baja.Time

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.Time}

Description:

  • Decode a Time from a String.

Source:
Overrides:
Parameters:
Name Type Description
str String
Returns:
Type
baja.Time

encodeToString() → {String}

Description:

  • Encode a Time to a String.

Source:
Overrides:
Returns:
Type
String

equals(obj) → {Boolean}

Description:

  • Equality test.

Source:
Overrides:
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

getHour() → {Number}

Description:

  • Return hours (0-23).

Source:
Returns:
Type
Number

getIcon() → {baja.Icon}

Description:

  • Return the Object's Icon.

Source:
Inherited From:
Returns:
Type
baja.Icon

getMillisecond() → {Number}

Description:

  • Return milliseconds (0-999).

Source:
Returns:
Type
Number

getMinute() → {Number}

Description:

  • Return minutes (0-59).

Source:
Returns:
Type
Number

getSecond() → {Number}

Description:

  • Return seconds (0-59).

Source:
Returns:
Type
Number

getTimeOfDayMillis() → {Number}

Description:

  • Return the milliseconds since the start of the day.

Source:
Returns:
Type
Number

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

isAfter(time) → {Boolean}

Description:

  • Return true if the specified time is after this time.

Source:
Parameters:
Name Type Description
time baja.Time
Returns:
Type
Boolean

isBefore(time) → {Boolean}

Description:

  • Return true if the specified time is before this time.

Source:
Parameters:
Name Type Description
time baja.Time
Returns:
Type
Boolean

make(obj) → {baja.Time}

Description:

  • Make a Time.

Source:
Overrides:
Example
// An object literal is used for the method's arguments...
  var t1 = baja.$("baja:Time").make({
    hour: 23,
    min: 12,
    sec: 15,
    ms: 789
  });
  
  // ...or use a baja.RelTime to specify hour, min, sec and ms...
  var t2 = baja.$("baja:Time").make({
    relTime: timeOfDayMillis 
  });
  
  // ...or pass in milliseconds past midnight...
  var t3 = baja.Time.make(12345);
Parameters:
Name Type Description
obj Object

the object literal used for the method's arguments.

Properties
Name Type Attributes Description
hour Number <optional>

hours - (0-23).
min Number <optional>

minutes - (0-59).
sec Number <optional>

seconds - (0-59).
ms Number <optional>

milliseconds - (0-999).
relTime baja.RelTime <optional>

if defined, this is the milliseconds
since the start of the day. This overrides the other hour, min, sec and ms
arguments.
Returns:
Type
baja.Time

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()

Source:
Overrides:
See:
  • .toTimeStringSync

toTimeString(objopt) → {Promise.<String>}

Description:

  • Asynchronously get a String representation of the time.

    This method is invoked asynchronously. A Function callback or an object
    literal that contains a Function callback must be supplied.

Source:
Example
myTime.toTimeString().then(function(timeStr) {
    baja.outln("The time is: " + timeStr);
  });
Parameters:
Name Type Attributes Description
obj Object | function <optional>

the Object Literal for the method's arguments
or a Function that will be called with the formatting time String.

Properties
Name Type Attributes Description
ok function <optional>

(Deprecated: use Promise) the Function callback
that will be invoked once the time has been formatted into a String.
fail function <optional>

(Deprecated: use Promise) the Function
callback that will be invoked if a fatal error occurs whilst formatting the
String.
textPattern String <optional>

the text pattern to use for formatting.
If not specified, then the user's default time format text pattern will be
used.
show Number <optional>

flags used to format the time. For more
information, please see baja.TimeFormat.
Returns:

promise to be resolved with the time string

Type
Promise.<String>

toTimeStringSync(obj) → {String}

Description:

  • Synchronously get a String representation of the time.

    This method is invoked synchronously. The string result will be returned
    directly from this function. Since building up Time string
    representations requires the baja lexicon, said lexicon must already be
    retrieved and passed into this method. Apart from that, the behavior is the
    same as the asynchronous baja.Time#toTimeString.

Source:
Parameters:
Name Type Description
obj Object | function

the Object Literal for the method's arguments
or a Function that will be called with the formatting time String.

Properties
Name Type Attributes Description
textPattern String <optional>

the text pattern to use for formatting.
If not specified, then the user's default time format text pattern will be
used.
show Number <optional>

flags used to format the time. For more
information, please see baja.TimeFormat.
lex

the baja lexicon
Throws:

if the lexicon is not passed in, or is not the
baja lexicon

Type
Error
Returns:
Type
String

valueOf() → {Number}

Source:
Overrides:
Returns:

milliseconds since the beginning of the day.

Type
Number

(static) make(obj) → {baja.Time}

Description:

  • Make a Time.

Source:
Example
// An object literal is used for the method's arguments...
  var t1 = baja.Time.make({
    hour: 23,
    min: 12,
    sec: 15,
    ms: 789
  });
  
  // ...or use a baja.RelTime to specify hour, min, sec and ms...
  var t2 = baja.Time.make({
    relTime: myRelTime
  });
  
  // ...or pass in milliseconds past midnight...
  var t3 = baja.Time.make(12345);
Parameters:
Name Type Description
obj Object | number

the object literal used for the method's
arguments, or number of milliseconds past the start of the day.

Properties
Name Type Attributes Description
hour Number <optional>

hours - (0-23).
min Number <optional>

minutes - (0-59).
sec Number <optional>

seconds - (0-59).
ms Number <optional>

milliseconds - (0-999).
relTime baja.RelTime <optional>

if defined, this is the milliseconds
since the start of the day. This overrides the other hour, min, sec and ms
arguments.
milliseconds number <optional>

if defined, this is the milliseconds
since the start of the day. This overrides the other hour, min, sec, ms
and relTime arguments.
Returns:
Type
baja.Time