new PermissionsMap()
PermissionsMap for a given array of baja.Permissions.
Extends
Members
-
<static> DEFAULT
-
The default instance is the empty permissions map.
-
<static> SUPER_USER
-
The SUPER_USER instance automatically is granted
all permissions in any category.
Methods
-
<static> make(permissions)
-
Make a PermissionsMap object.
Parameters:
Name Type Description permissions
Array.<baja.Permissions> an array of baja.Permissions to decode.
Returns:
- Type
- baja.PermissionsMap
-
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 inPromise.resolve()
if unsure.- Type
- baja.Simple | Promise.<baja.Simple>
-
decodeFromString()
-
Decode
PermissionsMap
from aString
.- Overrides:
Returns:
- Type
- baja.PermissionsMap
-
encodeToString()
-
Encode
PermissionsMap
to aString
.- 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 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
-
getPermissions(index)
-
Given a category index, return the mapped baja.Permissions
or return baja.Permissions.none if no mapping configured.
If this is the super user, then always return baja.Permissions.all.Parameters:
Name Type Description index
Number Throws:
-
If index is not a number or less than 1
- Type
- Error
Returns:
- Type
- baja.Permissions
-
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
isSuperUser()
-
Return if this is the super user permission map which
is automatically granted all permissions in all categories. -
make(permissions)
-
Make a PermissionsMap object.
Make map where category number maps to array index.
The first item (permissions[0]) is unused. If any
items in the array are null, then baja.Permissions.none
is assumed.Parameters:
Name Type Description permissions
Array.<baja.Permissions> an array of baja.Permissions to decode.
- Overrides:
Returns:
- Type
- baja.PermissionsMap
-
newCopy( [exact])
-
Every value may be cloned using the
newCopy
method.Please note that
Simple
s 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(otherPermissionsMap)
-
Create a new baja.PermissionsMap from the bitwise OR of this baja.PermissionsMap
instance and the specified baja.PermissionsMap.Parameters:
Name Type Description otherPermissionsMap
baja.PermissionsMap Returns:
- Type
- baja.PermissionsMap
-
size()
-
Get the number of category/permissions mappings.
-
toString( [cx])
-
Returns the String representation of this object.
Parameters:
Name Type Argument Description cx
Object <optional>
optional context information to be used when
formatting the string- Inherited From:
- See:
Returns:
a string (if no context passed), or
either a string or a Promise (if context passed). -
valueOf()
-
Return the inner value of the object.
By default the object's instance is returned.
- Inherited From:
Returns:
the inner value of the object or just the object's instance.
- Type
- *