APIGuild

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

Hierarchy

• APIPartialGuild
  • APIGuild
    • GatewayGuildCreateDispatchData

Index

Properties

• afk_channel_id
• afk_timeout
• application_id
• approximate_member_count
• approximate_presence_count
• banner
• default_message_notifications
• description
• discovery_splash
• emojis
• explicit_content_filter
• features
• hub_type
• icon
• icon_hash
• id
• max_members
• max_presences
• max_stage_video_channel_users
• max_video_channel_users
• mfa_level
• name
• nsfw_level
• owner
• owner_id
• permissions
• preferred_locale
• premium_progress_bar_enabled
• premium_subscription_count
• premium_tier
• public_updates_channel_id
• region
• roles
• rules_channel_id
• safety_alerts_channel_id
• splash
• stickers
• system_channel_flags
• system_channel_id
• vanity_url_code
• verification_level
• welcome_screen
• widget_channel_id
• widget_enabled

Properties

afk_channel_id

afk_channel_id: null | string

afk_timeout

afk_timeout: 1800 | 3600 | 60 | 300 | 900

application_id

application_id: null | string

optionalapproximate_member_count

approximate_member_count?: number

optionalapproximate_presence_count

approximate_presence_count?: number

banner

banner: null | string

Overrides APIPartialGuild.banner

default_message_notifications

default_message_notifications: GuildDefaultMessageNotifications

description

description: null | string

Overrides APIPartialGuild.description

discovery_splash

discovery_splash: null | string

emojis

emojis: APIEmoji[]

explicit_content_filter

explicit_content_filter: GuildExplicitContentFilter

features

features: GuildFeature[]

Overrides APIPartialGuild.features

hub_type

hub_type: null | GuildHubType

icon

icon: null | string

Inherited from APIPartialGuild.icon

optionalicon_hash

icon_hash?: null | string

id

id: string

Inherited from APIPartialGuild.id

optionalmax_members

max_members?: number

optionalmax_presences

max_presences?: null | number

optionalmax_stage_video_channel_users

max_stage_video_channel_users?: number

optionalmax_video_channel_users

max_video_channel_users?: number

mfa_level

mfa_level: GuildMFALevel

name

name: string

Inherited from APIPartialGuild.name

nsfw_level

nsfw_level: GuildNSFWLevel

optionalowner

owner?: boolean

owner_id

owner_id: string

optionalpermissions

permissions?: string

preferred_locale

preferred_locale: Locale

premium_progress_bar_enabled

premium_progress_bar_enabled: boolean

optionalpremium_subscription_count

premium_subscription_count?: number

premium_tier

premium_tier: GuildPremiumTier

public_updates_channel_id

public_updates_channel_id: null | string

region

region: string

roles

roles: APIRole[]

rules_channel_id

rules_channel_id: null | string

safety_alerts_channel_id

safety_alerts_channel_id: null | string

splash

splash: null | string

Inherited from APIPartialGuild.splash

stickers

stickers: APISticker[]

system_channel_flags

system_channel_flags: GuildSystemChannelFlags

system_channel_id

system_channel_id: null | string

vanity_url_code

vanity_url_code: null | string

Overrides APIPartialGuild.vanity_url_code

verification_level

verification_level: GuildVerificationLevel

Overrides APIPartialGuild.verification_level

optionalwelcome_screen

welcome_screen?: APIGuildWelcomeScreen

Overrides APIPartialGuild.welcome_screen

optionalwidget_channel_id

widget_channel_id?: null | string

optionalwidget_enabled

widget_enabled?: boolean