Skip to main content

ChannelEditedEvent

ChannelEditedEvent = object

Event data emitted when a visible channel's properties or permissions change.

Properties​

channelGroupId​

channelGroupId: ChannelGroupGuid

The channel group containing the channel.

channelPermission?​

optional channelPermission?: ChannelPermission

Optional updated permissions for the channel.

communityId​

communityId: CommunityGuid

description?​

optional description?: string

Optional updated description.

iconAssetUri?​

optional iconAssetUri?: string

Optional updated icon URI.

id​

id: ChannelGuid

The unique identifier of the edited channel.

name​

name: string

The updated name of the channel.

roleOrMemberIds​

roleOrMemberIds: RoleOrMemberGuid[]

Updated IDs of roles or members with specific access rules.

useChannelGroupPermission​

useChannelGroupPermission: boolean

Whether the channel inherits permissions from its channel group.