Skip to main content

DiscordGuild

@discordeno/bot

Documentation / @discordeno/bot / DiscordGuild

Interface: DiscordGuild

Defined in: packages/types/dist/types/discord/guild.d.ts:13

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

Properties​

afk_channel_id​

afk_channel_id: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:79

Id of afk channel

afk_timeout​

afk_timeout: number

Defined in: packages/types/dist/types/discord/guild.d.ts:19

Afk timeout in seconds

application_id​

application_id: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:87

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

approximate_member_count?​

optional approximate_member_count: number

Defined in: packages/types/dist/types/discord/guild.d.ts:57

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: packages/types/dist/types/discord/guild.d.ts:59

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

banner: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:105

Banner hash

channels?​

optional channels: DiscordChannel[]

Defined in: packages/types/dist/types/discord/guild.d.ts:99

Channels in the guild

default_message_notifications​

default_message_notifications: DefaultMessageNotificationLevels

Defined in: packages/types/dist/types/discord/guild.d.ts:25

Default message notifications level

description​

description: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:47

The description of a guild

discovery_splash​

discovery_splash: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:73

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

emojis​

emojis: DiscordEmoji[]

Defined in: packages/types/dist/types/discord/guild.d.ts:85

Custom guild emojis

explicit_content_filter​

explicit_content_filter: ExplicitContentFilterLevels

Defined in: packages/types/dist/types/discord/guild.d.ts:27

Explicit content filter level

features​

features: GuildFeatures[]

Defined in: packages/types/dist/types/discord/guild.d.ts:29

Enabled guild features

icon​

icon: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:67

Icon hash

icon_hash?​

optional icon_hash: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:69

Icon hash, returned when in the template object

id​

id: string

Defined in: packages/types/dist/types/discord/guild.d.ts:65

Guild id

incidents_data​

incidents_data: DiscordIncidentsData

Defined in: packages/types/dist/types/discord/guild.d.ts:119

The incidents data for this guild

joined_at?​

optional joined_at: string

Defined in: packages/types/dist/types/discord/guild.d.ts:93

When this guild was joined at

large?​

optional large: boolean

Defined in: packages/types/dist/types/discord/guild.d.ts:35

True if this is considered a large guild

max_members?​

optional max_members: number

Defined in: packages/types/dist/types/discord/guild.d.ts:43

The maximum number of members for the guild

max_presences?​

optional max_presences: null | number

Defined in: packages/types/dist/types/discord/guild.d.ts:41

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: packages/types/dist/types/discord/guild.d.ts:55

Maximum amount of users in a stage video channel

max_video_channel_users?​

optional max_video_channel_users: number

Defined in: packages/types/dist/types/discord/guild.d.ts:53

The maximum amount of users in a video channel

member_count?​

optional member_count: number

Defined in: packages/types/dist/types/discord/guild.d.ts:39

Total number of members in this guild

members?​

optional members: DiscordMember[]

Defined in: packages/types/dist/types/discord/guild.d.ts:97

Users in the guild

mfa_level​

mfa_level: MfaLevels

Defined in: packages/types/dist/types/discord/guild.d.ts:31

Required MFA level for the guild

name​

name: string

Defined in: packages/types/dist/types/discord/guild.d.ts:15

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

nsfw_level​

nsfw_level: GuildNsfwLevel

Defined in: packages/types/dist/types/discord/guild.d.ts:61

Guild NSFW level

owner?​

optional owner: boolean

Defined in: packages/types/dist/types/discord/guild.d.ts:17

True if the user is the owner of the guild

owner_id​

owner_id: string

Defined in: packages/types/dist/types/discord/guild.d.ts:75

Id of the owner

permissions?​

optional permissions: string

Defined in: packages/types/dist/types/discord/guild.d.ts:77

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

preferred_locale​

preferred_locale: string

Defined in: packages/types/dist/types/discord/guild.d.ts:107

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: packages/types/dist/types/discord/guild.d.ts:63

Whether the guild has the boost progress bar enabled

premium_subscription_count?​

optional premium_subscription_count: number

Defined in: packages/types/dist/types/discord/guild.d.ts:51

The number of boosts this guild currently has

premium_tier​

premium_tier: PremiumTiers

Defined in: packages/types/dist/types/discord/guild.d.ts:49

Premium tier (Server Boost level)

presences?​

optional presences: Partial<DiscordPresenceUpdate>[]

Defined in: packages/types/dist/types/discord/guild.d.ts:103

Presences of the members in the guild, will only include non-offline members if the size is greater than large threshold

public_updates_channel_id​

public_updates_channel_id: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:109

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

roles​

roles: DiscordRole[]

Defined in: packages/types/dist/types/discord/guild.d.ts:83

Roles in the guild

rules_channel_id​

rules_channel_id: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:91

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

safety_alerts_channel_id​

safety_alerts_channel_id: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:117

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: packages/types/dist/types/discord/guild.d.ts:126

Soundboard sounds in the guild

Remarks​

Only sent by the gateway

splash​

splash: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:71

Splash hash

stage_instances?​

optional stage_instances: DiscordStageInstance[]

Defined in: packages/types/dist/types/discord/guild.d.ts:113

Stage instances in the guild

stickers?​

optional stickers: DiscordSticker[]

Defined in: packages/types/dist/types/discord/guild.d.ts:115

Custom guild stickers

system_channel_flags​

system_channel_flags: SystemChannelFlags

Defined in: packages/types/dist/types/discord/guild.d.ts:33

System channel flags

system_channel_id​

system_channel_id: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:89

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

threads?​

optional threads: DiscordChannel[]

Defined in: packages/types/dist/types/discord/guild.d.ts:101

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

unavailable?​

optional unavailable: boolean

Defined in: packages/types/dist/types/discord/guild.d.ts:37

True if this guild is unavailable due to an outage

vanity_url_code​

vanity_url_code: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:45

The vanity url code for the guild

verification_level​

verification_level: VerificationLevels

Defined in: packages/types/dist/types/discord/guild.d.ts:23

Verification level required for the guild

voice_states?​

optional voice_states: Omit<DiscordVoiceState, "guildId">[]

Defined in: packages/types/dist/types/discord/guild.d.ts:95

States of members currently in voice channels; lacks the guild_id key

welcome_screen?​

optional welcome_screen: DiscordWelcomeScreen

Defined in: packages/types/dist/types/discord/guild.d.ts:111

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: null | string

Defined in: packages/types/dist/types/discord/guild.d.ts:81

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: packages/types/dist/types/discord/guild.d.ts:21

True if the server widget is enabled