Skip to main content

CommunityRoleEditedEvent

CommunityRoleEditedEvent = object

Event payload emitted when a role's properties are modified.

Properties

beforeCommunityRoleId?

optional beforeCommunityRoleId: CommunityRoleGuid

The ID of the role that appears after this role in the list. May be undefined.


channelPermission

channelPermission: ChannelPermission

The updated default channel permissions.


colorHex

colorHex: string

The updated hex color code of the role.


communityId

communityId: CommunityGuid

The unique identifier of the community where the role exists.


communityPermission

communityPermission: CommunityPermission

The updated community-level permissions.


id

id: CommunityRoleGuid

The unique identifier of the edited role.


isMentionable

isMentionable: boolean

The updated mentionable setting.


name

name: string

The updated display name of the role.