bajaScript

Class: Permissions

baja. Permissions

new Permissions()

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.

Extends

Members

<static> ADMIN_INVOKE :Number

Admin invoke mask.

Type:
  • Number

<static> ADMIN_READ :Number

Admin read mask.

Type:
  • Number

<static> ADMIN_WRITE :Number

Admin write mask.

Type:
  • Number

<static> all :baja.Permissions

All permissions.

Type:

<static> DEFAULT :baja.Permissions

Default permissions instance (none).

Type:

<static> none :baja.Permissions

No permissions.

Type:

<static> OPERATOR_INVOKE :Number

Operator invoke mask.

Type:
  • Number

<static> OPERATOR_READ :Number

Operator read mask.

Type:
  • Number

<static> OPERATOR_WRITE :Number

Operator write mask.

Type:
  • Number

Methods

<static> make(perm)

Make a permissions object.

Parameters:
Name Type Description
perm String | Number

the permissions to decode.
Returns:
Type
baja.Permissions

decodeAsync(str [, batch])

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.

Parameters:
Name Type Argument Description
str string
batch baja.comm.Batch <optional>

optional batch to use
Inherited From:
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()

Decode Permissions from a String.

Overrides:
Returns:
Type
baja.Permissions

encodeToString()

Encode Permissions to a String.

Overrides:
Returns:
Type
String

equals(obj)

Equality test.

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

equivalent(obj)

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.

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

getAgents( [is] [, batch])

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

Parameters:
Name Type Argument 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.
Inherited From:
See:
Returns:

A promise that will resolve with the Agent Info.

Type
Promise

getIcon()

Return the Object's Icon.

Inherited From:
Returns:
Type
baja.Icon

getMask()

Return the mask for the permissions.

Returns:
Type
Number

getType()

Get the type of this instance.

Inherited From:
Returns:
Type
Type

getTypeDisplayName( [cx])

Gets the friendly type display name for this object.

Parameters:
Name Type Argument Description
cx Object <optional>

a context to be passed down to Type
Since:
  • Niagara 4.10
Inherited From:
See:
  • baja.Type#getDisplayName
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)

Return true if the specified permissions are enabled.

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

hasAdminInvoke()

Is the admin invoke permission enabled?

Returns:
Type
Boolean

hasAdminRead()

Is the admin read permission enabled?

Returns:
Type
Boolean

hasAdminWrite()

Is the admin write permission enabled?

Returns:
Type
Boolean

hasOperatorInvoke()

Is the operator invoke permission enabled?

Returns:
Type
Boolean

hasOperatorRead()

Is the operator read permission enabled?

Returns:
Type
Boolean

hasOperatorWrite()

Is the operator write permission enabled?

Returns:
Type
Boolean

make(perm)

Make a permissions object.

Parameters:
Name Type Description
perm String | Number

the permissions to decode.
Overrides:
Returns:
Type
baja.Permissions

newCopy( [exact])

Every value may be cloned using the newCopy method.

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

Parameters:
Name Type Argument Description
exact Boolean <optional>

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

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

or(otherPermissions)

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

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

toString()

Return a String representation of the Permissions.

Overrides:
Returns:
Type
String

valueOf()

Inherited From:
Returns:

the string encoding of the Simple, by default

Type
String