Class KiiACLEntry

Represents a KiiACLEntry object

Hierarchy

KiiACLEntry

Index

Methods

Methods

getAction

getAction(): KiiACLAction

- Defined in src/acl.ts:207
Get the action that is being permitted/restricted in this entry

Returns KiiACLAction
action

getGrant

getGrant(): boolean

- Defined in src/acl.ts:240
Get whether or not the action is being permitted to the subject

Returns boolean
true if the action is being permitted

getSubject

getSubject(): KiiACLSubject

- Defined in src/acl.ts:223
Get the subject that is being permitted/restricted in this entry

Returns KiiACLSubject
subject instance.

setAction

setAction(value: KiiACLAction): void

- Defined in src/acl.ts:199
The action that is being permitted/restricted. Possible values:

Parameters
- value: KiiACLAction
  
  The action being permitted/restricted
Returns void

setGrant

setGrant(value: boolean): KiiACLEntry

- Defined in src/acl.ts:231
Set whether or not the action is being permitted to the subject

Parameters
- value: boolean
  
  true if the action is permitted, false otherwise
Returns KiiACLEntry

setSubject

setSubject(value: KiiACLSubject): void

- Defined in src/acl.ts:215
Set the subject to which the action/grant is being applied

Parameters
- value: KiiACLSubject
  
  subject instance.
Returns void

Static entryWithSubject

entryWithSubject(subject: KiiACLSubject, action: KiiACLAction): KiiACLEntry

- Defined in src/acl.ts:260
Create a KiiACLEntry object with a subject and action

The entry will not be applied on the server until the KiiACL object is explicitly saved. This method simply returns a working KiiACLEntry with a specified subject and action.

Parameters
- subject: KiiACLSubject
  
  Subject to which the action/grant is being applied
- action: KiiACLAction
  
  One of the specified KiiACLAction values the permissions is being applied to
Returns KiiACLEntry
A KiiACLEntry object with the specified attributes

Generated using TypeDoc