ChatPermissionManager | Convergence JavaScript Client API Documentation

Allows getting and setting permissions for the various capabilities of Chats. The specific permissions are defined in ChatPermission. Permissions can be assigned per-DomainUser, per-UserGroup, or for everybody (setWorldPermissions).

Generally speaking, more specific permissions override less-specific ones. So a user's explicit permission would override the group's permission which the user is in, which would itself override any world permission for this Chat.

Hierarchy

AbstractPermissionManager<ChatPermission>
- ChatPermissionManager

Index

Methods

addGroupPermissions

addGroupPermissions(permissions: StringMapLike<Set<ChatPermission> | ChatPermission[]>): Promise<void>

Inherited from AbstractPermissionManager.addGroupPermissions

Adds the given permissions to any existing permissions for all given groups.

Parameters
- permissions: StringMapLike<Set<ChatPermission> | ChatPermission[]>
  
  an object, mapping group Ids to an set of desired permission strings to be added
Returns Promise<void>

A resolved promise if successful

addUserPermissions

addUserPermissions(permissions: DomainUserMapping<Set<ChatPermission> | ChatPermission[]>): Promise<void>

Inherited from AbstractPermissionManager.addUserPermissions

Adds the given permissions to any existing permissions for all given users.

Parameters
- permissions: DomainUserMapping<Set<ChatPermission> | ChatPermission[]>
  
  an object, mapping usernames to an set of desired permission strings to be added
Returns Promise<void>

A resolved promise if successful

addWorldPermissions

addWorldPermissions(permissions: Set<ChatPermission> | ChatPermission[]): Promise<void>

Inherited from AbstractPermissionManager.addWorldPermissions

Adds the given permissions to any existing WORLD permissions.

Parameters
- permissions: Set<ChatPermission> | ChatPermission[]
  
  an set of permission strings
Returns Promise<void>

A resolved promise if successful

getAllGroupPermissions

getAllGroupPermissions(): Promise<Map<string, Set<ChatPermission>>>

Inherited from AbstractPermissionManager.getAllGroupPermissions

Returns the permissions for all groups.

Returns Promise<Map<string, Set<ChatPermission>>>

A promise, which resolves with a map of permission strings per group ID.

getAllUserPermissions

getAllUserPermissions(): Promise<DomainUserIdMap<Set<ChatPermission>>>

Inherited from AbstractPermissionManager.getAllUserPermissions

Returns the permissions for all users.

Returns Promise<DomainUserIdMap<Set<ChatPermission>>>

A promise, which resolves with a map of permission strings per username.

getGroupPermissions

getGroupPermissions(groupId: string): Promise<Set<ChatPermission>>

Inherited from AbstractPermissionManager.getGroupPermissions

Returns the permissions for the given group.

Parameters
- groupId: string
  
  an existing group ID
Returns Promise<Set<ChatPermission>>

A promise, which resolves with an set of permission strings

getPermissions

getPermissions(): Promise<IAllPermissions<ChatPermission>>

Inherited from AbstractPermissionManager.getPermissions

Returns Promise<IAllPermissions<ChatPermission>>

getUserPermissions

getUserPermissions(username: string): Promise<Set<ChatPermission>>

Inherited from AbstractPermissionManager.getUserPermissions

Returns the permissions for the given user.

Parameters
- username: string
  
  an existing user's username
Returns Promise<Set<ChatPermission>>

A promise, which resolves with an set of permission strings

getWorldPermissions

getWorldPermissions(): Promise<Set<ChatPermission>>

Inherited from AbstractPermissionManager.getWorldPermissions

Returns the permissions for WORLD.

Returns Promise<Set<ChatPermission>>

A promise, which resolves with an set of permission strings

id

id(): string

Returns string

The id of the chat this permissions manager manages permissions for.

removeGroupPermissions

removeGroupPermissions(permissions: StringMapLike<Set<ChatPermission> | ChatPermission[]>): Promise<void>

Inherited from AbstractPermissionManager.removeGroupPermissions

Removes the given permissions from any of the provided groups' permissions for this chatId.

Parameters
- permissions: StringMapLike<Set<ChatPermission> | ChatPermission[]>
  
  An object, mapping group IDs to an set of desired permission strings to be removed
Returns Promise<void>

A resolved promise if successful

removeUserPermissions

removeUserPermissions(permissions: DomainUserMapping<Set<ChatPermission> | ChatPermission[]>): Promise<void>

Inherited from AbstractPermissionManager.removeUserPermissions

Removes the given permissions from any of the provided users' permissions for this chatId.

Parameters
- permissions: DomainUserMapping<Set<ChatPermission> | ChatPermission[]>
  
  An object, mapping usernames to an set of desired permission strings to be removed
Returns Promise<void>

A resolved promise if successful

removeWorldPermissions

removeWorldPermissions(permissions: Set<ChatPermission> | ChatPermission[]): Promise<void>

Inherited from AbstractPermissionManager.removeWorldPermissions

Removes the given permissions from any existing WORLD permissions.

Parameters
- permissions: Set<ChatPermission> | ChatPermission[]
  
  an set of permission strings
Returns Promise<void>

A resolved promise if successful

resolveSessionPermissions

resolveSessionPermissions(): Promise<Set<ChatPermission>>

Inherited from AbstractPermissionManager.resolveSessionPermissions

Returns the resolved permissions for the current user for this target. Resolved means computed from the set of any relevant world, group or user permissions.

Returns Promise<Set<ChatPermission>>

setGroupPermissions

setGroupPermissions(permissions: StringMapLike<Set<ChatPermission> | ChatPermission[]>, replaceAll?: boolean): Promise<void>

Inherited from AbstractPermissionManager.setGroupPermissions

Sets the given permissions for the given groups.

Parameters
- permissions: StringMapLike<Set<ChatPermission> | ChatPermission[]>
  
  an object which maps one or more group IDs to their new set of permissions
- replaceAll: boolean = false
  
  Determines if the map passed in represents the entire set of group permissions to set. All permissions for other groups will be removed. The default is false.
Returns Promise<void>

A resolved promise if successful

setUserPermissions

setUserPermissions(permissions: DomainUserMapping<Set<ChatPermission> | ChatPermission[]>, replaceAll?: boolean): Promise<void>

Inherited from AbstractPermissionManager.setUserPermissions

Sets the given permissions for the given users

Parameters
- permissions: DomainUserMapping<Set<ChatPermission> | ChatPermission[]>
  
  an object which maps one or more usernames to their new set of permissions
- replaceAll: boolean = false
  
  Determines if the map passed in represents the entire set of user permissions to set. All permissions for other user will be removed. The default is false.
Returns Promise<void>

A resolved promise if successful

setWorldPermissions

setWorldPermissions(permissions: Set<ChatPermission> | ChatPermission[]): Promise<void>

Inherited from AbstractPermissionManager.setWorldPermissions

Sets the given permissions for WORLD.

Parameters
- permissions: Set<ChatPermission> | ChatPermission[]
  
  an set of permission strings
Returns Promise<void>

A resolved promise if successful

Hierarchy

Index

Methods

Methods

addGroupPermissions

Parameters

permissions: StringMapLike<Set<ChatPermission> | ChatPermission[]>

Returns Promise<void>

addUserPermissions

Parameters

permissions: DomainUserMapping<Set<ChatPermission> | ChatPermission[]>

Returns Promise<void>

addWorldPermissions

Parameters

permissions: Set<ChatPermission> | ChatPermission[]

Returns Promise<void>

getAllGroupPermissions

Returns Promise<Map<string, Set<ChatPermission>>>

getAllUserPermissions

Returns Promise<DomainUserIdMap<Set<ChatPermission>>>

getGroupPermissions

Parameters

groupId: string

Returns Promise<Set<ChatPermission>>

getPermissions

Returns Promise<IAllPermissions<ChatPermission>>

getUserPermissions

Parameters

username: string

Returns Promise<Set<ChatPermission>>

getWorldPermissions

Returns Promise<Set<ChatPermission>>

id

Returns string

removeGroupPermissions

Parameters

permissions: StringMapLike<Set<ChatPermission> | ChatPermission[]>

Returns Promise<void>

removeUserPermissions

Parameters

permissions: DomainUserMapping<Set<ChatPermission> | ChatPermission[]>

Returns Promise<void>

removeWorldPermissions

Parameters

permissions: Set<ChatPermission> | ChatPermission[]

Returns Promise<void>

resolveSessionPermissions

Returns Promise<Set<ChatPermission>>

setGroupPermissions

Parameters

permissions: StringMapLike<Set<ChatPermission> | ChatPermission[]>

replaceAll: boolean = false

Returns Promise<void>

setUserPermissions

Parameters

permissions: DomainUserMapping<Set<ChatPermission> | ChatPermission[]>

replaceAll: boolean = false

Returns Promise<void>

setWorldPermissions

Parameters

permissions: Set<ChatPermission> | ChatPermission[]

Returns Promise<void>