Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface APIGuild

Hierarchy

Index

Properties

afk_channel_id: null | string

ID of afk channel

afk_timeout: number

afk timeout in seconds

application_id: null | string

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

approximate_member_count?: number

This field is only received from https://discord.com/developers/docs/resources/guild#get-guild with the with_counts query parameter set to true

approximate_presence_count?: number

This field is only received from https://discord.com/developers/docs/resources/guild#get-guild with the with_counts query parameter set to true

banner: null | string
channels?: APIChannel[]

Channels in the guild

default_message_notifications: GuildDefaultMessageNotifications
description: null | string

The description for the guild

discovery_splash: null | string

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

emojis: APIEmoji[]
explicit_content_filter: GuildExplicitContentFilter
features: GuildFeature[]
guild_scheduled_events?: APIGuildScheduledEvent[]

The scheduled events in the guild

hub_type: null | GuildHubType

The type of Student Hub the guild is

icon: null | string
icon_hash?: null | string

Icon hash, returned when in the template object

id: string

Guild id

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

max_presences?: null | number

The maximum number of presences for the guild (null is always returned, apart from the largest of guilds)

max_video_channel_users?: number

The maximum amount of users in a video channel

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

mfa_level: GuildMFALevel
name: string

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

nsfw_level: GuildNSFWLevel
owner?: boolean

true if the user is the owner of the guild

owner_id: string

ID of owner

permissions?: string

Total permissions for the user in the guild (excludes overrides)

preferred_locale: string

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

default

"en-US"

premium_progress_bar_enabled: boolean

Whether the guild has the boost progress bar enabled.

premium_subscription_count?: number

The number of boosts this guild currently has

premium_tier: GuildPremiumTier
presences?: GatewayPresenceUpdate[]

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

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

region: string

Voice region id for the guild

deprecated

This field has been deprecated in favor of rtc_region on the channel.

roles: APIRole[]
rules_channel_id: null | string

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

splash: null | string
stage_instances?: APIStageInstance[]

The stage instances in the guild

stickers: APISticker[]
system_channel_flags: Types.GuildSystemChannelFlags
system_channel_id: null | string

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

threads?: APIChannel[]

Threads in the guild

unavailable?: boolean

true if this guild is unavailable due to an outage

vanity_url_code: null | string

The vanity url code for the guild

verification_level: GuildVerificationLevel
voice_states?: Omit<GatewayVoiceState, "guild_id">[]

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

welcome_screen?: APIGuildWelcomeScreen

The welcome screen of a Community guild, shown to new members

Returned in the invite object

widget_channel_id?: null | string

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

widget_enabled?: boolean

true if the guild widget is enabled

Generated using TypeDoc