Interface RolesInterface

Hierarchy

RolesInterface

Index

Properties

actions adminRole? allRole? helpers loggedInRole? roles

Methods

addUserToRoles allow getUserRoles registerAction registerHelper userHasPermission

Properties

actions

actions: string[]

`Optional` adminRole

adminRole?: RoleInterface

`Optional` allRole

allRole?: RoleInterface

helpers

helpers: string[]

`Optional` loggedInRole

loggedInRole?: RoleInterface

roles

roles: { [name: string]: RoleInterface }

Type declaration

[name: string]: RoleInterface

Methods

addUserToRoles

addUserToRoles(context: Context, roles: string | string[]): Promise<any>
Parameters
- context: Context
- roles: string | string[]
Returns Promise<any>
- Defined in roles.ts:34

allow

allow(context: Context, roles: string[], action: string, args: CheckPermissionArgs): Promise<boolean>
Parameters
- context: Context
- roles: string[]
- action: string
- args: CheckPermissionArgs
Returns Promise<boolean>
- Defined in roles.ts:27

getUserRoles

getUserRoles(userId: string, roles: string[], includeSpecial: boolean): string[]
Parameters
- userId: string
- roles: string[]
- includeSpecial: boolean
Returns string[]
- Defined in roles.ts:26

registerAction

registerAction(name: string): void
Parameters
- name: string
Returns void
- Defined in roles.ts:24

registerHelper

registerHelper(name: string): void
Parameters
- name: string
Returns void
- Defined in roles.ts:25

userHasPermission

userHasPermission(context: Context, action: string, args: CheckPermissionArgs): Promise<boolean>
Parameters
- context: Context
- action: string
- args: CheckPermissionArgs
Returns Promise<boolean>
- Defined in roles.ts:33