discord.js

interface GatewayGuildCreateDispatchData

extends

APIGuild
external
export interface GatewayGuildCreateDispatchData extends APIGuild

See also: https://discord.com/developers/docs/topics/gateway-events#guild-createhttps://discord.com/developers/docs/topics/gateway-events#guild-create-guild-create-extra-fields

external
afk_channel_id : Snowflake | null

ID of afk channel

Inherited from: APIGuild

external
afk_timeout : 1800 | 3600 | 60 | 300 | 900

afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600

Inherited from: APIGuild

external
application_id : Snowflake | null

Application id of the guild creator if it is bot-created

Inherited from: APIGuild

optionalexternal
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

optionalexternal
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

Banner hash

Inherited from: APIGuild

See also: https://discord.com/developers/docs/reference#image-formatting

external
channels : (APIChannel & { type: Exclude<GuildChannelType, ThreadChannelType>; })[]

Channels in the guild**This field is only sent within the GUILD_CREATE event**

See also: https://discord.com/developers/docs/resources/channel#channel-object

external
default_message_notifications : GuildDefaultMessageNotifications

Default message notifications level

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level

external
description : string | null

The description for the guild

Inherited from: APIGuild

external
discovery_splash : string | null

Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature

Inherited from: APIGuild

See also: https://discord.com/developers/docs/reference#image-formatting

external
emojis : APIEmoji[]

Custom guild emojis

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/emoji#emoji-object

external
explicit_content_filter : GuildExplicitContentFilter

Explicit content filter level

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level

external
features : GuildFeature[]

Enabled guild features

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/guild#guild-object-guild-features

external
guild_scheduled_events : APIGuildScheduledEvent[]

The scheduled events in the guild**This field is only sent within the GUILD_CREATE event**

See also: https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object

external
hub_type : GuildHubType | null

The type of Student Hub the guild is

Inherited from: APIGuild

optionalexternal
icon_hash? : string | null

Icon hash, returned when in the template object

Inherited from: APIGuild

See also: https://discord.com/developers/docs/reference#image-formatting

external
icon : string | null

Icon hash

Inherited from: APIPartialGuild

See also: https://discord.com/developers/docs/reference#image-formatting

external
incidents_data : APIIncidentsData | null

The incidents data for this guild

Inherited from: APIGuild

external
joined_at : string

When this guild was joined at**This field is only sent within the GUILD_CREATE event**

external
large : boolean

true if this is considered a large guild**This field is only sent within the GUILD_CREATE event**

optionalexternal
max_members? : number

The maximum number of members for the guild

Inherited from: APIGuild

optionalexternal
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

optionalexternal
max_stage_video_channel_users? : number

The maximum amount of users in a stage video channel

Inherited from: APIGuild

optionalexternal
max_video_channel_users? : number

The maximum amount of users in a video channel

Inherited from: APIGuild

external
member_count : number

Total number of members in this guild**This field is only sent within the GUILD_CREATE event**

external
members : APIGuildMember[]

Users in the guild**This field is only sent within the GUILD_CREATE event**

See also: https://discord.com/developers/docs/resources/guild#guild-member-object

external
mfa_level : GuildMFALevel

Required MFA level for the guild

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/guild#guild-object-mfa-level

external
name : string

Guild name (2-100 characters, excluding trailing and leading whitespace)

Inherited from: APIPartialGuild

external
nsfw_level : GuildNSFWLevel

The nsfw level of the guild

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level

external
owner_id : Snowflake

ID of owner

Inherited from: APIGuild

optionalexternal
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

optionalexternal
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

See also: https://en.wikipedia.org/wiki/Bit_field

external
preferred_locale : Locale = "en-US"

The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"

Inherited from: APIGuild

external
premium_progress_bar_enabled : boolean

Whether the guild has the boost progress bar enabled.

Inherited from: APIGuild

optionalexternal
premium_subscription_count? : number

The number of boosts this guild currently has

Inherited from: APIGuild

external
premium_tier : GuildPremiumTier

Premium tier (Server Boost level)

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/guild#guild-object-premium-tier

external
presences : GatewayPresenceUpdate[]

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**

See also: https://discord.com/developers/docs/topics/gateway-events#presence-update

external
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

deprecatedexternal
region : string

Voice region id for the guild

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/voice#voice-region-object

external
roles : APIRole[]

Roles in the guild

Inherited from: APIGuild

See also: https://discord.com/developers/docs/topics/permissions#role-object

external
rules_channel_id : Snowflake | null

The id of the channel where Community guilds can display rules and/or guidelines

Inherited from: APIGuild

external
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

external
soundboard_sounds : APISoundboardSound[]

The soundboard sounds in the guild**This field is only sent within the GUILD_CREATE event**

See also: https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object

external
splash : string | null

Splash hash

Inherited from: APIPartialGuild

See also: https://discord.com/developers/docs/reference#image-formatting

external
stage_instances : APIStageInstance[]

The stage instances in the guild**This field is only sent within the GUILD_CREATE event**

See also: https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-stage-instance-structure

external
stickers : APISticker[]

Custom guild stickers

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/sticker#sticker-object

external
system_channel_flags : GuildSystemChannelFlags

System channel flags

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags

external
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

external
threads : (APIChannel & { type: ThreadChannelType; })[]

Threads in the guild**This field is only sent within the GUILD_CREATE event**

See also: https://discord.com/developers/docs/resources/channel#channel-object

optionalexternal
unavailable? : boolean

true if this guild is unavailable due to an outage

external
vanity_url_code : string | null

The vanity url code for the guild

Inherited from: APIGuild

external
verification_level : GuildVerificationLevel

Verification level required for the guild

Inherited from: APIGuild

See also: https://discord.com/developers/docs/resources/guild#guild-object-verification-level

external
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**

See also: https://discord.com/developers/docs/resources/voice#voice-state-object

optionalexternal
welcome_screen? : APIGuildWelcomeScreen

The welcome screen of a Community guild, shown to new membersReturned in the invite object

Inherited from: APIGuild

optionalexternal
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

optionalexternal
widget_enabled? : boolean

true if the guild widget is enabled

Inherited from: APIGuild