FacetsMap

baja. FacetsMap

Represents a baja:FacetsMap in BajaScript. FacetsMap is simply a
mapping of String names to Facets instances. It is mostly intended for
internal use by the framework.

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

Constructor

new FacetsMap()

Source:

Extends

Members

(static) DEFAULT

Source:

(static) NULL

Source:

Methods

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

Source:
Overrides:
Parameters:
Name Type Attributes Description
str string
batch baja.comm.Batch <optional>
Returns:
Type
Promise.<baja.FacetsMap>

decodeFromString(str, paramsopt) → {baja.FacetsMap}

Source:
Overrides:
Parameters:
Name Type Attributes Description
str string
params Object <optional>
Properties
Name Type Attributes Default Description
unsafe Boolean <optional>
 false

if set to true, this will allow
decodeFromString to continue. If not, decodeFromString will throw an error. This flag is for
internal bajaScript use only. All external implementations should use decodeAsync instead.
Returns:
Type
baja.FacetsMap

encodeToString() → {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:
Overrides:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

get(key) → {baja.Facets}

Source:
Parameters:
Name Type Description
key string
Returns:

the Facets at that key, or baja.Facets.NULL if
not found

Type
baja.Facets

getAgents(isopt, batchopt) → {Promise}

Description:

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

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

getIcon() → {baja.Icon}

Description:

  • Return the Object's Icon.

Source:
Overrides:
Returns:
Type
baja.Icon

getType() → {Type}

Description:

  • Get the type of this instance.

Source:
Overrides:
Returns:
Type
Type

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

Description:

  • Gets the friendly type display name for this object.

Source:
Since:
  • Niagara 4.10
Overrides:
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

isNull() → {boolean}

Source:
Returns:

true if empty

Type
boolean

list() → {Array.<string>}

Source:
Returns:

all string keys in this FacetsMap instance

Type
Array.<string>

make(obj) → {baja.FacetsMap}

Source:
Overrides:
Parameters:
Name Type Description
obj object

a mapping of string keys to baja.Facets instances
Returns:
Type
baja.FacetsMap

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

the string encoding of the Simple, by default

Type
String

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

Source:
Parameters:
Name Type Description
obj object

a mapping of string keys to baja.Facets instances
Returns:
Type
baja.FacetsMap