ChannelCreatedEvent
ChannelCreatedEvent =
object
Event data emitted when a channel becomes visible to your code. This includes newly created channels and existing channels that your code can now see due to permission changes.
Properties
beforeChannelId?
optionalbeforeChannelId:ChannelGuid
Optional ID of the channel that this channel was positioned before.
channelGroupId
channelGroupId:
ChannelGroupGuid
The channel group containing the new channel.
channelPermission
channelPermission:
ChannelPermission
The effective permissions for the channel.
channelType
channelType:
number
The type of channel (Text, ThreadedText, Voice, or App).
communityAppId?
optionalcommunityAppId:CommunityAppGuid
For app channels, the associated community app ID.
communityId
communityId:
CommunityGuid
description?
optionaldescription:string
Optional description of the channel.
iconAssetUri?
optionaliconAssetUri:string
Optional URI for the channel icon.
id
id:
ChannelGuid
The unique identifier of the created channel.
name
name:
string
The name of the channel.
roleOrMemberIds?
optionalroleOrMemberIds:RoleOrMemberGuid[]
IDs of roles or members with specific access rules on this channel.
useChannelGroupPermission
useChannelGroupPermission:
boolean
Whether the channel inherits permissions from its channel group.
webRtcMembers?
optionalwebRtcMembers:WebRtcUserDeviceEvent[]
For voice channels, the current WebRTC members.