PermissionManager
Defined in: packages/channel/src/management/permissions.ts:101
Extends
Section titled “Extends”EventEmitter
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PermissionManager():
PermissionManager
Defined in: packages/channel/src/management/permissions.ts:110
Returns
Section titled “Returns”PermissionManager
Overrides
Section titled “Overrides”EventEmitter.constructor
Methods
Section titled “Methods”addListener()
Section titled “addListener()”addListener(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:16
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.addListener
assignRoleToUser()
Section titled “assignRoleToUser()”assignRoleToUser(
userId,roleId):Promise<void>
Defined in: packages/channel/src/management/permissions.ts:261
Parameters
Section titled “Parameters”userId
Section titled “userId”string
roleId
Section titled “roleId”string
Returns
Section titled “Returns”Promise<void>
checkPermission()
Section titled “checkPermission()”checkPermission(
check):Promise<PermissionResult>
Defined in: packages/channel/src/management/permissions.ts:313
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<PermissionResult>
createRole()
Section titled “createRole()”createRole(
roleData):Promise<Role>
Defined in: packages/channel/src/management/permissions.ts:187
Parameters
Section titled “Parameters”roleData
Section titled “roleData”Omit<Role, "id" | "createdAt" | "updatedAt">
Returns
Section titled “Returns”Promise<Role>
createUser()
Section titled “createUser()”createUser(
userData):Promise<User>
Defined in: packages/channel/src/management/permissions.ts:116
Parameters
Section titled “Parameters”userData
Section titled “userData”Omit<User, "id" | "createdAt" | "updatedAt">
Returns
Section titled “Returns”Promise<User>
deleteRole()
Section titled “deleteRole()”deleteRole(
roleId):Promise<boolean>
Defined in: packages/channel/src/management/permissions.ts:235
Parameters
Section titled “Parameters”roleId
Section titled “roleId”string
Returns
Section titled “Returns”Promise<boolean>
deleteUser()
Section titled “deleteUser()”deleteUser(
userId):Promise<boolean>
Defined in: packages/channel/src/management/permissions.ts:172
Parameters
Section titled “Parameters”userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<boolean>
emit()
Section titled “emit()”emit(
eventName, …args):boolean
Defined in: packages/channel/src/shared/event-emitter.ts:44
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”EventEmitter.emit
eventNames()
Section titled “eventNames()”eventNames():
string[]
Defined in: packages/channel/src/shared/event-emitter.ts:71
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”EventEmitter.eventNames
getRole()
Section titled “getRole()”getRole(
roleId):Promise<Role|null>
Defined in: packages/channel/src/management/permissions.ts:205
Parameters
Section titled “Parameters”roleId
Section titled “roleId”string
Returns
Section titled “Returns”Promise<Role | null>
getUser()
Section titled “getUser()”getUser(
userId):Promise<User|null>
Defined in: packages/channel/src/management/permissions.ts:138
Parameters
Section titled “Parameters”userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<User | null>
getUserPermissions()
Section titled “getUserPermissions()”getUserPermissions(
userId):Promise<Permission[]>
Defined in: packages/channel/src/management/permissions.ts:368
Parameters
Section titled “Parameters”userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<Permission[]>
getUserRoles()
Section titled “getUserRoles()”getUserRoles(
userId):Promise<Role[]>
Defined in: packages/channel/src/management/permissions.ts:389
Parameters
Section titled “Parameters”userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<Role[]>
hasPermission()
Section titled “hasPermission()”hasPermission(
userId,resource,action,resourceId?,context?):Promise<boolean>
Defined in: packages/channel/src/management/permissions.ts:329
Parameters
Section titled “Parameters”userId
Section titled “userId”string
resource
Section titled “resource”action
Section titled “action”resourceId?
Section titled “resourceId?”string
context?
Section titled “context?”Returns
Section titled “Returns”Promise<boolean>
listenerCount()
Section titled “listenerCount()”listenerCount(
eventName):number
Defined in: packages/channel/src/shared/event-emitter.ts:67
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”EventEmitter.listenerCount
listRoles()
Section titled “listRoles()”listRoles():
Role[]
Defined in: packages/channel/src/management/permissions.ts:408
Returns
Section titled “Returns”Role[]
listUsers()
Section titled “listUsers()”listUsers(
filters?):User[]
Defined in: packages/channel/src/management/permissions.ts:394
Parameters
Section titled “Parameters”filters?
Section titled “filters?”isActive?
Section titled “isActive?”boolean
roleId?
Section titled “roleId?”string
Returns
Section titled “Returns”User[]
off(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:20
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.off
on(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:9
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”once(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:35
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.once
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
eventName?):this
Defined in: packages/channel/src/shared/event-emitter.ts:57
Parameters
Section titled “Parameters”eventName?
Section titled “eventName?”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:31
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeListener
removeRoleFromUser()
Section titled “removeRoleFromUser()”removeRoleFromUser(
userId,roleId):Promise<void>
Defined in: packages/channel/src/management/permissions.ts:289
Parameters
Section titled “Parameters”userId
Section titled “userId”string
roleId
Section titled “roleId”string
Returns
Section titled “Returns”Promise<void>
requirePermission()
Section titled “requirePermission()”requirePermission(
userId,resource,action,resourceId?,context?):Promise<void>
Defined in: packages/channel/src/management/permissions.ts:347
Parameters
Section titled “Parameters”userId
Section titled “userId”string
resource
Section titled “resource”action
Section titled “action”resourceId?
Section titled “resourceId?”string
context?
Section titled “context?”Returns
Section titled “Returns”Promise<void>
updateRole()
Section titled “updateRole()”updateRole(
roleId,updates):Promise<Role>
Defined in: packages/channel/src/management/permissions.ts:209
Parameters
Section titled “Parameters”roleId
Section titled “roleId”string
updates
Section titled “updates”Partial<Role>
Returns
Section titled “Returns”Promise<Role>
updateUser()
Section titled “updateUser()”updateUser(
userId,updates):Promise<User>
Defined in: packages/channel/src/management/permissions.ts:142
Parameters
Section titled “Parameters”userId
Section titled “userId”string
updates
Section titled “updates”Partial<User>
Returns
Section titled “Returns”Promise<User>