Skip to main content

CommunityEditedEvent

CommunityEditedEvent = object

Event data emitted when a community's properties are modified.

Properties​

communityId​

communityId: CommunityGuid

The unique identifier of the community.

defaultChannelId?​

optional defaultChannelId?: ChannelGuid

Optional channel ID for the system messages channel.

description?​

optional description?: string

isAgeRestricted​

isAgeRestricted: boolean

joinThrottle?​

optional joinThrottle?: CommunityJoinThrottle

Optional updated CommunityJoinThrottle configuration.

name​

name: string

The updated name of the community.

ownerUserId​

ownerUserId: UserGuid

The user ID of the community owner.

pictureAssetUri?​

optional pictureAssetUri?: string

Optional updated URI for the community's picture asset.

pictureHex​

pictureHex: string

The updated hex color code for the community picture background.

rejectUnverifiedEmail​

rejectUnverifiedEmail: boolean

Whether users without verified email addresses are rejected from joining.