Skip to main content

DiscordGuild

@discordeno/bot • Docs

Documentation / @discordeno/bot / DiscordGuild

Interface: DiscordGuild

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

Properties​

afk_channel_id​

afk_channel_id: null | string

Id of afk channel

Defined in​

packages/types/dist/types/discord.d.ts:794

afk_timeout​

afk_timeout: number

Afk timeout in seconds

Defined in​

packages/types/dist/types/discord.d.ts:734

application_id​

application_id: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:802

approximate_member_count?​

optional approximate_member_count: number

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

Defined in​

packages/types/dist/types/discord.d.ts:772

approximate_presence_count?​

optional approximate_presence_count: number

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

Defined in​

packages/types/dist/types/discord.d.ts:774

banner: null | string

Banner hash

Defined in​

packages/types/dist/types/discord.d.ts:820

channels?​

optional channels: DiscordChannel[]

Channels in the guild

Defined in​

packages/types/dist/types/discord.d.ts:814

default_message_notifications​

default_message_notifications: DefaultMessageNotificationLevels

Default message notifications level

Defined in​

packages/types/dist/types/discord.d.ts:740

description​

description: null | string

The description of a guild

Defined in​

packages/types/dist/types/discord.d.ts:762

discovery_splash​

discovery_splash: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:788

emojis​

emojis: DiscordEmoji[]

Custom guild emojis

Defined in​

packages/types/dist/types/discord.d.ts:800

explicit_content_filter​

explicit_content_filter: ExplicitContentFilterLevels

Explicit content filter level

Defined in​

packages/types/dist/types/discord.d.ts:742

features​

features: GuildFeatures[]

Enabled guild features

Defined in​

packages/types/dist/types/discord.d.ts:744

icon​

icon: null | string

Icon hash

Defined in​

packages/types/dist/types/discord.d.ts:782

icon_hash?​

optional icon_hash: null | string

Icon hash, returned when in the template object

Defined in​

packages/types/dist/types/discord.d.ts:784

id​

id: string

Guild id

Defined in​

packages/types/dist/types/discord.d.ts:780

joined_at?​

optional joined_at: string

When this guild was joined at

Defined in​

packages/types/dist/types/discord.d.ts:808

large?​

optional large: boolean

True if this is considered a large guild

Defined in​

packages/types/dist/types/discord.d.ts:750

max_members?​

optional max_members: number

The maximum number of members for the guild

Defined in​

packages/types/dist/types/discord.d.ts:758

max_presences?​

optional max_presences: null | number

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

Defined in​

packages/types/dist/types/discord.d.ts:756

max_stage_video_channel_users?​

optional max_stage_video_channel_users: number

Maximum amount of users in a stage video channel

Defined in​

packages/types/dist/types/discord.d.ts:770

max_video_channel_users?​

optional max_video_channel_users: number

The maximum amount of users in a video channel

Defined in​

packages/types/dist/types/discord.d.ts:768

member_count?​

optional member_count: number

Total number of members in this guild

Defined in​

packages/types/dist/types/discord.d.ts:754

members?​

optional members: DiscordMember[]

Users in the guild

Defined in​

packages/types/dist/types/discord.d.ts:812

mfa_level​

mfa_level: MfaLevels

Required MFA level for the guild

Defined in​

packages/types/dist/types/discord.d.ts:746

name​

name: string

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

Defined in​

packages/types/dist/types/discord.d.ts:730

nsfw_level​

nsfw_level: GuildNsfwLevel

Guild NSFW level

Defined in​

packages/types/dist/types/discord.d.ts:776

owner?​

optional owner: boolean

True if the user is the owner of the guild

Defined in​

packages/types/dist/types/discord.d.ts:732

owner_id​

owner_id: string

Id of the owner

Defined in​

packages/types/dist/types/discord.d.ts:790

permissions?​

optional permissions: string

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

Defined in​

packages/types/dist/types/discord.d.ts:792

preferred_locale​

preferred_locale: string

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

Defined in​

packages/types/dist/types/discord.d.ts:822

premium_progress_bar_enabled​

premium_progress_bar_enabled: boolean

Whether the guild has the boost progress bar enabled

Defined in​

packages/types/dist/types/discord.d.ts:778

premium_subscription_count?​

optional premium_subscription_count: number

The number of boosts this guild currently has

Defined in​

packages/types/dist/types/discord.d.ts:766

premium_tier​

premium_tier: PremiumTiers

Premium tier (Server Boost level)

Defined in​

packages/types/dist/types/discord.d.ts:764

presences?​

optional presences: Partial<DiscordPresenceUpdate>[]

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

Defined in​

packages/types/dist/types/discord.d.ts:818

public_updates_channel_id​

public_updates_channel_id: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:824

roles​

roles: DiscordRole[]

Roles in the guild

Defined in​

packages/types/dist/types/discord.d.ts:798

rules_channel_id​

rules_channel_id: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:806

safety_alerts_channel_id​

safety_alerts_channel_id: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:832

soundboard_sounds?​

optional soundboard_sounds: DiscordSoundboardSound[]

Soundboard sounds in the guild

Remarks​

Only sent by the gateway

Defined in​

packages/types/dist/types/discord.d.ts:839

splash​

splash: null | string

Splash hash

Defined in​

packages/types/dist/types/discord.d.ts:786

stage_instances?​

optional stage_instances: DiscordStageInstance[]

Stage instances in the guild

Defined in​

packages/types/dist/types/discord.d.ts:828

stickers?​

optional stickers: DiscordSticker[]

Custom guild stickers

Defined in​

packages/types/dist/types/discord.d.ts:830

system_channel_flags​

system_channel_flags: SystemChannelFlags

System channel flags

Defined in​

packages/types/dist/types/discord.d.ts:748

system_channel_id​

system_channel_id: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:804

threads?​

optional threads: DiscordChannel[]

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

Defined in​

packages/types/dist/types/discord.d.ts:816

unavailable?​

optional unavailable: boolean

True if this guild is unavailable due to an outage

Defined in​

packages/types/dist/types/discord.d.ts:752

vanity_url_code​

vanity_url_code: null | string

The vanity url code for the guild

Defined in​

packages/types/dist/types/discord.d.ts:760

verification_level​

verification_level: VerificationLevels

Verification level required for the guild

Defined in​

packages/types/dist/types/discord.d.ts:738

voice_states?​

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

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

Defined in​

packages/types/dist/types/discord.d.ts:810

welcome_screen?​

optional welcome_screen: DiscordWelcomeScreen

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

Defined in​

packages/types/dist/types/discord.d.ts:826

widget_channel_id?​

optional widget_channel_id: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:796

widget_enabled?​

optional widget_enabled: boolean

True if the server widget is enabled

Defined in​

packages/types/dist/types/discord.d.ts:736