APIGuild

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

Hierarchy

• APIPartialGuild
  • APIGuild

Index

Properties

• afk_channel_id
• afk_timeout
• application_id
• approximate_member_count
• approximate_presence_count
• banner
• channels
• default_message_notifications
• description
• discovery_splash
• embed_channel_id
• embed_enabled
• emojis
• explicit_content_filter
• features
• icon
• id
• joined_at
• large
• max_members
• max_presences
• max_video_channel_users
• member_count
• members
• mfa_level
• name
• owner
• owner_id
• permissions
• permissions_new
• preferred_locale
• premium_subscription_count
• premium_tier
• presences
• public_updates_channel_id
• region
• roles
• rules_channel_id
• splash
• system_channel_flags
• system_channel_id
• unavailable
• vanity_url_code
• verification_level
• voice_states
• welcome_screen
• widget_channel_id
• widget_enabled

Properties

afk_channel_id

afk_channel_id: null | string

afk_timeout

afk_timeout: number

application_id

application_id: null | string

optionalapproximate_member_count

approximate_member_count?: number

Returned by calling GET /guilds/{guild.id} with the query with_counts set to true

optionalapproximate_presence_count

approximate_presence_count?: number

Returned by calling GET /guilds/{guild.id} with the query with_counts set to true

banner

banner: null | string

Overrides APIPartialGuild.banner

optionalchannels

channels?: APIChannel[]

default_message_notifications

default_message_notifications: GuildDefaultMessageNotifications

description

description: null | string

Overrides APIPartialGuild.description

discovery_splash

discovery_splash: null | string

optionalembed_channel_id

embed_channel_id?: null | string

@deprecated

Use widget_channel_id instead

optionalembed_enabled

embed_enabled?: boolean

@deprecated

Use widget_enabled instead

emojis

emojis: APIEmoji[]

explicit_content_filter

explicit_content_filter: GuildExplicitContentFilter

features

features: GuildFeature[]

Overrides APIPartialGuild.features

icon

icon: null | string

Inherited from APIPartialGuild.icon

id

id: string

Inherited from APIPartialGuild.id

optionaljoined_at

joined_at?: string

optionallarge

large?: boolean

optionalmax_members

max_members?: number

optionalmax_presences

max_presences?: null | number

optionalmax_video_channel_users

max_video_channel_users?: number

optionalmember_count

member_count?: number

optionalmembers

members?: APIGuildMember[]

mfa_level

mfa_level: GuildMFALevel

name

name: string

Inherited from APIPartialGuild.name

optionalowner

owner?: boolean

owner_id

owner_id: string

optionalpermissions

permissions?: number

@deprecated

Use permissions_new instead

optionalpermissions_new

permissions_new?: string

preferred_locale

preferred_locale: string

optionalpremium_subscription_count

premium_subscription_count?: number

premium_tier

premium_tier: GuildPremiumTier

optionalpresences

presences?: GatewayPresenceUpdate[]

public_updates_channel_id

public_updates_channel_id: null | string

region

region: string

roles

roles: APIRole[]

rules_channel_id

rules_channel_id: null | string

splash

splash: null | string

Inherited from APIPartialGuild.splash

system_channel_flags

system_channel_flags: GuildSystemChannelFlags

system_channel_id

system_channel_id: null | string

optionalunavailable

unavailable?: boolean

Inherited from APIPartialGuild.unavailable

vanity_url_code

vanity_url_code: null | string

Overrides APIPartialGuild.vanity_url_code

verification_level

verification_level: GuildVerificationLevel

Overrides APIPartialGuild.verification_level

optionalvoice_states

voice_states?: Omit<GatewayVoiceState, guild_id>[]

optionalwelcome_screen

welcome_screen?: APIGuildWelcomeScreen

Overrides APIPartialGuild.welcome_screen

optionalwidget_channel_id

widget_channel_id?: null | string

optionalwidget_enabled

widget_enabled?: boolean