External module "core/security"

Index

Functions

Functions

addUserRight

addUserRight(user: any, node: any, nodeType: any, permission: any): Promise<void>

- Defined in core/security.ts:155
Adds a user right to a node

Parameters
- user: any
- node: any
- nodeType: any
  
  (entry|post)
- permission: any
Returns Promise<void>

canUser

canUser(user: any, model: any, permission: any, options?: any): any

- Defined in core/security.ts:70
Parameters
- user: any
- model: any
- permission: any
- Default value options: any = {}
Returns any

canUserManage

canUserManage(user: any, model: any, options?: any): any

- Defined in core/security.ts:66
Checks if a user can manage the given model. Always returns false if no model is given.

Parameters
- user: any
- model: any
- Default value options: any = {}
  
  (optional) allowMods allowAdmins
Returns any

canUserRead

canUserRead(user: any, model: any, options?: any): any

- Defined in core/security.ts:44
Checks if a user can read the given model

Parameters
- user: any
  
  (optional)
- model: any
- Default value options: any = {}
  
  (optional) allowMods allowAdmins
Returns any

canUserWrite

canUserWrite(user: any, model: any, options?: any): any

- Defined in core/security.ts:55
Checks if a user can write in the given model

Parameters
- user: any
  
  (optional)
- model: any
- Default value options: any = {}
  
  (optional) allowMods allowAdmins
Returns any

getHighestPermission

getHighestPermission(permissions: any): string

- Defined in core/security.ts:140
Parameters
- permissions: any
Returns string

getPermissionsEqualOrAbove

getPermissionsEqualOrAbove(permission: any): string[]

- Defined in core/security.ts:126
Parameters
- permission: any
Returns string[]

isAdmin

isAdmin(user: any, options?: any): any

- Defined in core/security.ts:118
Parameters
- user: any
- Default value options: any = {}
Returns any

isMod

isMod(user: any): any

- Defined in core/security.ts:110
Parameters
- user: any
Returns any

isUserWatching

isUserWatching(user: any, model: any): any

- Defined in core/security.ts:33
Checks if a user is watching the given model

Parameters
- user: any
  
  (optional)
- model: any
Returns any

removeUserRight

removeUserRight(user: any, node: any, permission: any): Promise<void>

- Defined in core/security.ts:192
Removes a user right from a node. If the permission does not match exactly, does nothing.

Parameters
- user: any
- node: any
- permission: any
Returns Promise<void>

Generated using TypeDoc