Permissions

baja. Permissions

new Permissions()

Description:

  • Permissions for a given security domain.

    This Constructor shouldn't be invoked directly. Please use the make()
    methods to create an instance of a Permissions Object.

Source:

Extends

Members

(static) ADMIN_INVOKE :Number

Description:

  • Admin invoke mask.

Source:

Admin invoke mask.

Type:
  • Number

(static) ADMIN_READ :Number

Description:

  • Admin read mask.

Source:

Admin read mask.

Type:
  • Number

(static) ADMIN_WRITE :Number

Description:

  • Admin write mask.

Source:

Admin write mask.

Type:
  • Number

(static) DEFAULT :baja.Permissions

Description:

  • Default permissions instance (none).

Source:

Default permissions instance (none).

Type:

(static) OPERATOR_INVOKE :Number

Description:

  • Operator invoke mask.

Source:

Operator invoke mask.

Type:
  • Number

(static) OPERATOR_READ :Number

Description:

  • Operator read mask.

Source:

Operator read mask.

Type:
  • Number

(static) OPERATOR_WRITE :Number

Description:

  • Operator write mask.

Source:

Operator write mask.

Type:
  • Number

(static) all :baja.Permissions

Description:

  • All permissions.

Source:

All permissions.

Type:

(static) none :baja.Permissions

Description:

  • No permissions.

Source:

No permissions.

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 be require asynchronous operations to decode. BOX is
    designed to handle these situations when decoding data from the station,
    but when user code needs to decode string-encoded Simples directly, prefer
    this method as it gives the individual Simple a chance to import Types,
    etc. to ensure that the decoded Simple is fully correct.

    The default implementation just returns decodeFromString directly.

Source:
Inherited From:
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() → {baja.Permissions}

Description:

  • Decode Permissions from a String.

Source:
Overrides:
Returns:
Type
baja.Permissions

encodeToString() → {String}

Description:

  • Encode Permissions 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

getIcon() → {baja.Icon}

Description:

  • Return the Object's Icon.

Source:
Inherited From:
Returns:
Type
baja.Icon

getMask() → {Number}

Description:

  • Return the mask for the permissions.

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

has(mask) → {Boolean}

Description:

  • Return true if the specified permissions are enabled.

Source:
Parameters:
Name Type Description
mask Number | baja.Permissions
Returns:
Type
Boolean

hasAdminInvoke() → {Boolean}

Description:

  • Is the admin invoke permission enabled?

Source:
Returns:
Type
Boolean

hasAdminRead() → {Boolean}

Description:

  • Is the admin read permission enabled?

Source:
Returns:
Type
Boolean

hasAdminWrite() → {Boolean}

Description:

  • Is the admin write permission enabled?

Source:
Returns:
Type
Boolean

hasOperatorInvoke() → {Boolean}

Description:

  • Is the operator invoke permission enabled?

Source:
Returns:
Type
Boolean

hasOperatorRead() → {Boolean}

Description:

  • Is the operator read permission enabled?

Source:
Returns:
Type
Boolean

hasOperatorWrite() → {Boolean}

Description:

  • Is the operator write permission enabled?

Source:
Returns:
Type
Boolean

make(perm) → {baja.Permissions}

Description:

  • Make a permissions object.

Source:
Overrides:
Parameters:
Name Type Description
perm String | Number

the permissions to decode.
Returns:
Type
baja.Permissions

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

or(otherPermissions) → {baja.Permissions}

Description:

  • Create a new baja.Permissions from the bitwise OR of this baja.Permissions
    instance and the specified baja.Permissions.

Source:
Parameters:
Name Type Description
otherPermissions baja.Permissions
Returns:
Type
baja.Permissions

toString() → {String}

Description:

  • Return a String representation of the Permissions.

Source:
Overrides:
Returns:
Type
String

valueOf() → {String}

Source:
Inherited From:
Returns:

the string encoding of the Simple, by default

Type
String

(static) make(perm) → {baja.Permissions}

Description:

  • Make a permissions object.

Source:
Parameters:
Name Type Description
perm String | Number

the permissions to decode.
Returns:
Type
baja.Permissions