GatewayGuildCreateDispatchData

export interface GatewayGuildCreateDispatchData extends APIGuild
export interface GatewayGuildCreateDispatchData extends APIGuild

Extends

APIGuild
afk_channel_id:Snowflake | null
ID of afk channel
Inherited from APIGuild
afk_timeout:1800 | 3600 | 60 | 300 | 900
afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600
Inherited from APIGuild
application_id:Snowflake | null
Application id of the guild creator if it is bot-created
Inherited from APIGuild
approximate_member_count?:number
Approximate number of members in this guild, returned from the GET /guilds/<id> and /users/@me/guilds (OAuth2) endpoints when with_counts is true
Inherited from APIGuild
approximate_presence_count?:number
Approximate number of non-offline members in this guild, returned from the GET /guilds/<id> and /users/@me/guilds (OAuth2) endpoints when with_counts is true
Inherited from APIGuild
Channels in the guild**This field is only sent within the GUILD_CREATE event**
description:string | null
The description for the guild
Inherited from APIGuild
discovery_splash:string | null
Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature
Inherited from APIGuild
guild_scheduled_events:APIGuildScheduledEvent[]
The scheduled events in the guild**This field is only sent within the GUILD_CREATE event**
hub_type:GuildHubType | null
The type of Student Hub the guild is
Inherited from APIGuild
icon_hash?:string | null
Icon hash, returned when in the template object
Inherited from APIGuild
incidents_data:APIIncidentsData | null
The incidents data for this guild
Inherited from APIGuild
joined_at:string
When this guild was joined at**This field is only sent within the GUILD_CREATE event**
large:boolean
true if this is considered a large guild**This field is only sent within the GUILD_CREATE event**
max_members?:number
The maximum number of members for the guild
Inherited from APIGuild
max_presences?:number | null
The maximum number of presences for the guild (null is always returned, apart from the largest of guilds)
Inherited from APIGuild
max_stage_video_channel_users?:number
The maximum amount of users in a stage video channel
Inherited from APIGuild
max_video_channel_users?:number
The maximum amount of users in a video channel
Inherited from APIGuild
member_count:number
Total number of members in this guild**This field is only sent within the GUILD_CREATE event**
members:APIGuildMember[]
Users in the guild**This field is only sent within the GUILD_CREATE event**
mfa_level:GuildMFALevel
Inherited from APIGuild
name:string
Guild name (2-100 characters, excluding trailing and leading whitespace)
Inherited from APIPartialGuild
owner_id:Snowflake
ID of owner
Inherited from APIGuild
owner?:boolean
true if the user is the owner of the guild**This field is only received from https://discord.com/developers/docs/resources/user#get-current-user-guilds**
Inherited from APIGuild
permissions?:Permissions
Total permissions for the user in the guild (excludes overrides)**This field is only received from https://discord.com/developers/docs/resources/user#get-current-user-guilds**
Inherited from APIGuild
preferred_locale:Locale
The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"
Default value
"en-US"
Inherited from APIGuild
premium_progress_bar_enabled:boolean
Whether the guild has the boost progress bar enabled.
Inherited from APIGuild
premium_subscription_count?:number
The number of boosts this guild currently has
Inherited from APIGuild
premium_tier:GuildPremiumTier
Presences of the members in the guild, will only include non-offline members if the size is greater than large_threshold**This field is only sent within the GUILD_CREATE event**
public_updates_channel_id:Snowflake | null
The id of the channel where admins and moderators of Community guilds receive notices from Discord
Inherited from APIGuild
Deprecated
region:string
This field has been deprecated in favor of rtc_region on the channel.
Deprecated
Voice region id for the guild
Inherited from APIGuild
rules_channel_id:Snowflake | null
The id of the channel where Community guilds can display rules and/or guidelines
Inherited from APIGuild
safety_alerts_channel_id:Snowflake | null
The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord
Inherited from APIGuild
soundboard_sounds:APISoundboardSound[]
The soundboard sounds in the guild**This field is only sent within the GUILD_CREATE event**
stage_instances:APIStageInstance[]
The stage instances in the guild**This field is only sent within the GUILD_CREATE event**
system_channel_id:Snowflake | null
The id of the channel where guild notices such as welcome messages and boost events are posted
Inherited from APIGuild
threads:(APIChannel & { type: ThreadChannelType; })[]
Threads in the guild**This field is only sent within the GUILD_CREATE event**
unavailable?:boolean
true if this guild is unavailable due to an outage
vanity_url_code:string | null
The vanity url code for the guild
Inherited from APIGuild
verification_level:GuildVerificationLevel
Inherited from APIGuild
voice_states:Omit<APIVoiceState, 'guild_id'>[]
States of members currently in voice channels; lacks the guild_id key**This field is only sent within the GUILD_CREATE event**
welcome_screen?:APIGuildWelcomeScreen
The welcome screen of a Community guild, shown to new membersReturned in the invite object
Inherited from APIGuild
widget_channel_id?:Snowflake | null
The channel id that the widget will generate an invite to, or null if set to no invite
Inherited from APIGuild
widget_enabled?:boolean
true if the guild widget is enabled
Inherited from APIGuild