Skip to main content

DiscordGuild

Documentation

Documentation / @discordeno/types / DiscordGuild

Interface: DiscordGuild

Defined in: discord/guild.ts:13

https://docs.discord.com/developers/resources/guild#guild-object-guild-structure

Extends​

Properties​

afk_channel_id​

afk_channel_id: string | null

Defined in: discord/guild.ts:50

Id of afk channel

afk_timeout​

afk_timeout: number

Defined in: discord/guild.ts:52

Afk timeout in seconds

application_id​

application_id: string | null

Defined in: discord/guild.ts:72

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

approximate_member_count?​

optional approximate_member_count?: number

Defined in: discord/guild.ts:102

Approximate number of members in this guild, returned from the GET /guilds/id endpoint when with_counts is true

approximate_presence_count?​

optional approximate_presence_count?: number

Defined in: discord/guild.ts:104

Approximate number of non-offline members in this guild, returned from the GET /guilds/id endpoint when with_counts is true

banner: string | null

Defined in: discord/guild.ts:88

Banner hash

channels?​

optional channels?: DiscordChannel[]

Defined in: discord/gateway.ts:447

Channels in the guild

Inherited from​

DiscordGuildCreateExtra.channels

default_message_notifications​

default_message_notifications: DefaultMessageNotificationLevels

Defined in: discord/guild.ts:60

Default message notifications level

description​

description: string | null

Defined in: discord/guild.ts:86

The description of a guild

discovery_splash​

discovery_splash: string | null

Defined in: discord/guild.ts:25

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

emojis​

emojis: DiscordEmoji[]

Defined in: discord/guild.ts:66

Custom guild emojis

explicit_content_filter​

explicit_content_filter: ExplicitContentFilterLevels

Defined in: discord/guild.ts:62

Explicit content filter level

features​

features: GuildFeatures[]

Defined in: discord/guild.ts:68

Enabled guild features

guild_scheduled_events?​

optional guild_scheduled_events?: DiscordScheduledEvent[]

Defined in: discord/gateway.ts:460

Scheduled events in the guild

Inherited from​

DiscordGuildCreateExtra.guild_scheduled_events

icon​

icon: string | null

Defined in: discord/guild.ts:19

Icon hash

icon_hash?​

optional icon_hash?: string | null

Defined in: discord/guild.ts:21

Icon hash, returned when in the template object

id​

id: string

Defined in: discord/guild.ts:15

Guild id

incidents_data​

incidents_data: DiscordIncidentsData | null

Defined in: discord/guild.ts:116

The incidents data for this guild

joined_at?​

optional joined_at?: string

Defined in: discord/gateway.ts:430

When this guild was joined at

Inherited from​

DiscordGuildCreateExtra.joined_at

large?​

optional large?: boolean

Defined in: discord/gateway.ts:432

If this is considered a large guild

Inherited from​

DiscordGuildCreateExtra.large

max_members?​

optional max_members?: number

Defined in: discord/guild.ts:82

The maximum number of members for the guild

max_presences?​

optional max_presences?: number | null

Defined in: discord/guild.ts:80

The maximum number of presences for the guild (the default value, currently 25000, is in effect when null is returned)

max_stage_video_channel_users?​

optional max_stage_video_channel_users?: number

Defined in: discord/guild.ts:100

Maximum amount of users in a stage video channel

max_video_channel_users?​

optional max_video_channel_users?: number

Defined in: discord/guild.ts:98

The maximum amount of users in a video channel

member_count?​

optional member_count?: number

Defined in: discord/gateway.ts:436

Total number of member in this guild

Inherited from​

DiscordGuildCreateExtra.member_count

members?​

optional members?: DiscordMemberWithUser[]

Defined in: discord/gateway.ts:445

Users in the guild

Inherited from​

DiscordGuildCreateExtra.members

mfa_level​

mfa_level: MfaLevels

Defined in: discord/guild.ts:70

Required MFA level for the guild

name​

name: string

Defined in: discord/guild.ts:17

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

nsfw_level​

nsfw_level: GuildNsfwLevel

Defined in: discord/guild.ts:108

Guild NSFW level

owner?​

optional owner?: boolean

Defined in: discord/guild.ts:32

True if the user is the owner of the guild

Remarks​

This field is only sent when using the Get Guilds endpoint

owner_id​

owner_id: string

Defined in: discord/guild.ts:34

Id of the owner

permissions?​

optional permissions?: string

Defined in: discord/guild.ts:41

Total permissions for the user in the guild (excludes overwrites and implicit permissions)

Remarks​

This field is only sent when using the Get Guilds endpoint

preferred_locale​

preferred_locale: string

Defined in: discord/guild.ts:94

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

premium_progress_bar_enabled​

premium_progress_bar_enabled: boolean

Defined in: discord/guild.ts:112

Whether the guild has the boost progress bar enabled

premium_subscription_count?​

optional premium_subscription_count?: number

Defined in: discord/guild.ts:92

The number of boosts this guild currently has

premium_tier​

premium_tier: PremiumTiers

Defined in: discord/guild.ts:90

Premium tier (Server Boost level)

presences?​

optional presences?: Partial<DiscordPresenceUpdate>[]

Defined in: discord/gateway.ts:456

Presences of the members in the guild

Remarks​

Will only include non-offline members if the size is greater than the large threshold.

Inherited from​

DiscordGuildCreateExtra.presences

public_updates_channel_id​

public_updates_channel_id: string | null

Defined in: discord/guild.ts:96

The id of the channel where admins and moderators of Community guilds receive notices from Discord

region?​

optional region?: string | null

Defined in: discord/guild.ts:48

Voice region id for the guild

Deprecated​

This field is deprecated and is replaced by Channel.rtc_region

roles​

roles: DiscordRole[]

Defined in: discord/guild.ts:64

Roles in the guild

rules_channel_id​

rules_channel_id: string | null

Defined in: discord/guild.ts:78

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

safety_alerts_channel_id​

safety_alerts_channel_id: string | null

Defined in: discord/guild.ts:114

The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord

soundboard_sounds?​

optional soundboard_sounds?: DiscordSoundboardSound[]

Defined in: discord/gateway.ts:462

Soundboard sounds in the guild

Inherited from​

DiscordGuildCreateExtra.soundboard_sounds

splash​

splash: string | null

Defined in: discord/guild.ts:23

Splash hash

stage_instances?​

optional stage_instances?: DiscordStageInstance[]

Defined in: discord/gateway.ts:458

Stage instances in the guild

Inherited from​

DiscordGuildCreateExtra.stage_instances

stickers?​

optional stickers?: DiscordSticker[]

Defined in: discord/guild.ts:110

Custom guild stickers

system_channel_flags​

system_channel_flags: SystemChannelFlags

Defined in: discord/guild.ts:76

System channel flags

system_channel_id​

system_channel_id: string | null

Defined in: discord/guild.ts:74

The id of the channel where guild notices such as welcome messages and boost events are posted

threads?​

optional threads?: DiscordChannel[]

Defined in: discord/gateway.ts:449

All active threads in the guild that the current user has permission to view

Inherited from​

DiscordGuildCreateExtra.threads

unavailable?​

optional unavailable?: boolean

Defined in: discord/gateway.ts:434

If the guild is unavailable due to an outage

Inherited from​

DiscordGuildCreateExtra.unavailable

vanity_url_code​

vanity_url_code: string | null

Defined in: discord/guild.ts:84

The vanity url code for the guild

verification_level​

verification_level: VerificationLevels

Defined in: discord/guild.ts:58

Verification level required for the guild

voice_states?​

optional voice_states?: Omit<DiscordVoiceState, "guild_id">[]

Defined in: discord/gateway.ts:443

States of members currently in voice channels

Remarks​

Lacks the guild_id key

Inherited from​

DiscordGuildCreateExtra.voice_states

welcome_screen?​

optional welcome_screen?: DiscordWelcomeScreen

Defined in: discord/guild.ts:106

The welcome screen of a Community guild, shown to new members, returned in an Invite's guild object

widget_channel_id?​

optional widget_channel_id?: string | null

Defined in: discord/guild.ts:56

The channel id that the widget will generate an invite to, or null if set to no invite

widget_enabled?​

optional widget_enabled?: boolean

Defined in: discord/guild.ts:54

True if the server widget is enabled