Class Acl

Creates a new Acl object, with an empty rule set for an object

Hierarchy

Acl

Constructors

constructor

new Acl(): Acl
Returns Acl

Properties

`Readonly` read

read: Permission = ...

The read permission of the object

`Readonly` write

write: Permission = ...

The write permission of the object

Methods

allowReadAccess

allowReadAccess(...userOrRole: TrustedEntity[]): Acl
Allows the given user or rule to read the object

Returns
this acl object
Parameters
- Rest ...userOrRole: TrustedEntity[]
  
  The user or role to allow
Returns Acl
- Defined in lib/Acl.ts:87

allowWriteAccess

allowWriteAccess(...userOrRole: TrustedEntity[]): Acl
Allows the given user or rule to write the object

Returns
this acl object
Parameters
- Rest ...userOrRole: TrustedEntity[]
  
  The user or role to allow
Returns Acl
- Defined in lib/Acl.ts:160

clear

clear(): void
Removes all acl rules, read and write access is public afterwards

Returns

Returns void
- Defined in lib/Acl.ts:24

copy

copy(acl: Acl): Acl
Copies permissions from another ACL

Returns
Parameters
- acl: Acl
  
  The ACL to copy from
Returns Acl
- Defined in lib/Acl.ts:35

deleteReadAccess

deleteReadAccess(...userOrRole: TrustedEntity[]): Acl
Deletes any read allow/deny rule for the given user or role

Returns
this acl object
Parameters
- Rest ...userOrRole: TrustedEntity[]
  
  The user or role
Returns Acl
- Defined in lib/Acl.ts:109

deleteWriteAccess

deleteWriteAccess(...userOrRole: TrustedEntity[]): Acl
Deletes any write allow/deny rule for the given user or role

Returns
this acl object
Parameters
- Rest ...userOrRole: TrustedEntity[]
  
  The user or role
Returns Acl
- Defined in lib/Acl.ts:182

denyReadAccess

denyReadAccess(...userOrRole: TrustedEntity[]): Acl
Denies the given user or rule to read the object

Returns
this acl object
Parameters
- Rest ...userOrRole: TrustedEntity[]
  
  The user or role to deny
Returns Acl
- Defined in lib/Acl.ts:98

denyWriteAccess

denyWriteAccess(...userOrRole: TrustedEntity[]): Acl
Denies the given user or rule to write the object

Returns
this acl object
Parameters
- Rest ...userOrRole: TrustedEntity[]
  
  The user or role to deny
Returns Acl
- Defined in lib/Acl.ts:171

fromJSON

fromJSON(json: JsonMap): void
Sets the acl rules form JSON

Returns
Parameters
- json: JsonMap
  
  The json encoded acls
Returns void
- Defined in lib/Acl.ts:205

isPublicReadAllowed

isPublicReadAllowed(): boolean
Gets whenever all users and roles have the permission to read the object

Returns
true If public access is allowed

Returns boolean
- Defined in lib/Acl.ts:46

isPublicWriteAllowed

isPublicWriteAllowed(): boolean
Gets whenever all users and roles have the permission to write the object

Returns
true If public access is allowed

Returns boolean
- Defined in lib/Acl.ts:119

isReadAllowed

isReadAllowed(userOrRole: TrustedEntity): boolean
Checks whenever the user or role is explicit allowed to read the object

Returns
true if read access is explicitly allowed for the given user or role
Parameters
- userOrRole: TrustedEntity
  
  The user or role to check for
Returns boolean
- Defined in lib/Acl.ts:67

isReadDenied

isReadDenied(userOrRole: TrustedEntity): boolean
Checks whenever the user or role is explicit denied to read the object

Returns
true if read access is explicitly denied for the given user or role
Parameters
- userOrRole: TrustedEntity
  
  The user or role to check for
Returns boolean
- Defined in lib/Acl.ts:77

isWriteAllowed

isWriteAllowed(userOrRole: TrustedEntity): boolean
Checks whenever the user or role is explicit allowed to write the object

Returns
true if write access is explicitly allowed for the given user or role
Parameters
- userOrRole: TrustedEntity
  
  The user or role to check for
Returns boolean
- Defined in lib/Acl.ts:140

isWriteDenied

isWriteDenied(userOrRole: TrustedEntity): boolean
Checks whenever the user or role is explicit denied to write the object

Returns
true if write access is explicitly denied for the given user or role
Parameters
- userOrRole: TrustedEntity
  
  The user or role to check for
Returns boolean
- Defined in lib/Acl.ts:150

setPublicReadAllowed

setPublicReadAllowed(): void
Sets whenever all users and roles should have the permission to read the object

Note: All other allow read rules will be removed.

Returns

Returns void
- Defined in lib/Acl.ts:57

setPublicWriteAllowed

setPublicWriteAllowed(): void
Sets whenever all users and roles should have the permission to write the object

Note: All other allow write rules will be removed.

Returns

Returns void
- Defined in lib/Acl.ts:130

toJSON

toJSON(): JsonMap
A JSON representation of the set of rules

Returns

Returns JsonMap
- Defined in lib/Acl.ts:192

Generated using TypeDoc