External module "security"

Index

Functions

Functions

getAttributePermission

getAttributePermission(entityName: string, attributeName: string, perms: PermissionInfo[] | undefined, roles: RoleInfo[] | undefined): EntityAttrPermissionValue

- Defined in security.ts:22
Define which type of attribute render allowed for user

Parameters
- entityName: string
  
  CUBA model entity
- attributeName: string
- perms: PermissionInfo[] | undefined
  
  list of user permissions
- roles: RoleInfo[] | undefined
  
  list of user roles
Returns EntityAttrPermissionValue

attribute could be not allowed to display (DENY), allowed for modification (MODIFY) or allowed in read only mode (VIEW).

getMaxAllowedAttrPerm

getMaxAllowedAttrPerm(entityName: string, attributeName: string, perms: PermissionInfo[]): PermissionInfo | null

- Defined in security.ts:92
Parameters
- entityName: string
- attributeName: string
- perms: PermissionInfo[]
Returns PermissionInfo | null

getMaxAllowedOpPerm

getMaxAllowedOpPerm(entityName: string, operation: EntityOperationType, perms: PermissionInfo[]): PermissionInfo | null

- Defined in security.ts:76
Parameters
- entityName: string
- operation: EntityOperationType
- perms: PermissionInfo[]
Returns PermissionInfo | null

hasRole

hasRole(roles: RoleInfo[], roleType: RoleType): boolean

- Defined in security.ts:115
Parameters
- roles: RoleInfo[]
- roleType: RoleType
Returns boolean

isOperationAllowed

isOperationAllowed(entityName: string, operation: EntityOperationType, perms: PermissionInfo[] | undefined, roles: RoleInfo[] | undefined): boolean

- Defined in security.ts:51
Define if operation (one of CRUD) on entity allowed or not for user

Parameters
- entityName: string
  
  CUBA model entity
- operation: EntityOperationType
  
  operation to be checked (CRUD)
- perms: PermissionInfo[] | undefined
  
  list of user permissions
- roles: RoleInfo[] | undefined
  
  list of user roles
Returns boolean

Generated using TypeDoc