Guild
Documentation / @discordeno/bot / Guild
Interface: Guild
Defined in: bot/src/transformers/types.ts:734
Properties
afkChannelId?
optional
afkChannelId:bigint
Defined in: bot/src/transformers/types.ts:802
Id of afk channel
afkTimeout
afkTimeout:
number
Defined in: bot/src/transformers/types.ts:740
Afk timeout in seconds
applicationId?
optional
applicationId:bigint
Defined in: bot/src/transformers/types.ts:810
Application id of the guild creator if it is bot-created
approximateMemberCount?
optional
approximateMemberCount:number
Defined in: bot/src/transformers/types.ts:780
Approximate number of members in this guild, returned from the GET /guilds/id endpoint when with_counts is true
approximatePresenceCount?
optional
approximatePresenceCount:number
Defined in: bot/src/transformers/types.ts:782
Approximate number of non-offline members in this guild, returned from the GET /guilds/id endpoint when with_counts is true
banner?
optional
banner:bigint
Defined in: bot/src/transformers/types.ts:828
Banner hash
channels
channels:
Collection
<bigint
,Channel
>
Defined in: bot/src/transformers/types.ts:822
Channels in the guild
defaultMessageNotifications
defaultMessageNotifications:
DefaultMessageNotificationLevels
Defined in: bot/src/transformers/types.ts:746
Default message notifications level
description?
optional
description:string
Defined in: bot/src/transformers/types.ts:768
The description of a guild
discoverySplash?
optional
discoverySplash:bigint
Defined in: bot/src/transformers/types.ts:796
Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature
emojis
emojis:
Collection
<bigint
,Emoji
>
Defined in: bot/src/transformers/types.ts:808
Custom guild emojis
explicitContentFilter
explicitContentFilter:
ExplicitContentFilterLevels
Defined in: bot/src/transformers/types.ts:748
Explicit content filter level
features
features: (
"banner"
|"verified"
|"animatedBanner"
|"animatedIcon"
|"applicationCommandPermissionsV2"
|"autoModeration"
|"community"
|"creatorMonetizableProvisional"
|"creatorStorePage"
|"developerSupportServer"
|"discoverable"
|"featurable"
|"invitesDisabled"
|"inviteSplash"
|"memberVerificationGateEnabled"
|"moreSoundboard"
|"moreStickers"
|"news"
|"partnered"
|"previewEnabled"
|"raidAlertsDisabled"
|"roleIcons"
|"roleSubscriptionsAvailableForPurchase"
|"roleSubscriptionsEnabled"
|"ticketedEventsEnabled"
|"vanityUrl"
|"vipRegions"
|"welcomeScreenEnabled"
)[]
Defined in: bot/src/transformers/types.ts:750
Enabled guild features
icon?
optional
icon:bigint
Defined in: bot/src/transformers/types.ts:790
Icon hash
iconHash?
optional
iconHash:bigint
Defined in: bot/src/transformers/types.ts:792
Icon hash, returned when in the template object
id
id:
bigint
Defined in: bot/src/transformers/types.ts:788
Guild id
incidentsData
incidentsData:
IncidentsData
Defined in: bot/src/transformers/types.ts:842
The incidents data for this guild
joinedAt?
optional
joinedAt:number
Defined in: bot/src/transformers/types.ts:816
When this guild was joined at
large?
optional
large:boolean
Defined in: bot/src/transformers/types.ts:756
True if this is considered a large guild
maxMembers?
optional
maxMembers:number
Defined in: bot/src/transformers/types.ts:764
The maximum number of members for the guild
maxPresences?
optional
maxPresences:number
Defined in: bot/src/transformers/types.ts:762
The maximum number of presences for the guild (the default value, currently 25000, is in effect when null is returned)
maxStageVideoChannelUsers?
optional
maxStageVideoChannelUsers:number
Defined in: bot/src/transformers/types.ts:778
Maximum amount of users in a stage video channel
maxVideoChannelUsers?
optional
maxVideoChannelUsers:number
Defined in: bot/src/transformers/types.ts:776
The maximum amount of users in a video channel
memberCount
memberCount:
number
Defined in: bot/src/transformers/types.ts:760
Total number of members in this guild
members
members:
Collection
<bigint
,Member
>
Defined in: bot/src/transformers/types.ts:820
Users in the guild
mfaLevel
mfaLevel:
MfaLevels
Defined in: bot/src/transformers/types.ts:752
Required MFA level for the guild
name
name:
string
Defined in: bot/src/transformers/types.ts:736
Guild name (2-100 characters, excluding trailing and leading whitespace)
nsfwLevel
nsfwLevel:
GuildNsfwLevel
Defined in: bot/src/transformers/types.ts:784
Guild NSFW level
owner?
optional
owner:boolean
Defined in: bot/src/transformers/types.ts:738
True if the user is the owner of the guild
ownerId
ownerId:
bigint
Defined in: bot/src/transformers/types.ts:798
Id of the owner
permissions
permissions:
bigint
Defined in: bot/src/transformers/types.ts:800
Total permissions for the user in the guild (excludes overwrites and implicit permissions)
preferredLocale
preferredLocale:
string
Defined in: bot/src/transformers/types.ts:830
The preferred locale of a Community guild; used in server discovery and notices from Discord; defaults to "en-US"
premiumProgressBarEnabled
premiumProgressBarEnabled:
boolean
Defined in: bot/src/transformers/types.ts:786
Whether the guild has the boost progress bar enabled
premiumSubscriptionCount?
optional
premiumSubscriptionCount:number
Defined in: bot/src/transformers/types.ts:774
The number of boosts this guild currently has
premiumTier
premiumTier:
PremiumTiers
Defined in: bot/src/transformers/types.ts:772
Premium tier (Server Boost level)
presences?
optional
presences:PresenceUpdate
[]
Defined in: bot/src/transformers/types.ts:826
Presences of the members in the guild, will only include non-offline members if the size is greater than large threshold
publicUpdatesChannelId?
optional
publicUpdatesChannelId:bigint
Defined in: bot/src/transformers/types.ts:832
The id of the channel where admins and moderators of Community guilds receive notices from Discord
roles
roles:
Collection
<bigint
,Role
>
Defined in: bot/src/transformers/types.ts:806
Roles in the guild
rulesChannelId?
optional
rulesChannelId:bigint
Defined in: bot/src/transformers/types.ts:814
The id of the channel where community guilds can display rules and/or guidelines
safetyAlertsChannelId?
optional
safetyAlertsChannelId:bigint
Defined in: bot/src/transformers/types.ts:840
The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord
shardId
shardId:
number
Defined in: bot/src/transformers/types.ts:770
splash?
optional
splash:bigint
Defined in: bot/src/transformers/types.ts:794
Splash hash
stageInstances?
optional
stageInstances:StageInstance
[]
Defined in: bot/src/transformers/types.ts:836
Stage instances in the guild
stickers?
optional
stickers:Collection
<bigint
,Sticker
>
Defined in: bot/src/transformers/types.ts:838
Custom guild stickers
systemChannelFlags
systemChannelFlags:
SystemChannelFlags
Defined in: bot/src/transformers/types.ts:754
System channel flags
systemChannelId?
optional
systemChannelId:bigint
Defined in: bot/src/transformers/types.ts:812
The id of the channel where guild notices such as welcome messages and boost events are posted
threads
threads:
Collection
<bigint
,Channel
>
Defined in: bot/src/transformers/types.ts:824
All active threads in the guild that the current user has permission to view
toggles
toggles:
GuildToggles
Defined in: bot/src/transformers/types.ts:769
unavailable?
optional
unavailable:boolean
Defined in: bot/src/transformers/types.ts:758
True if this guild is unavailable due to an outage
vanityUrlCode?
optional
vanityUrlCode:string
Defined in: bot/src/transformers/types.ts:766
The vanity url code for the guild
verificationLevel
verificationLevel:
VerificationLevels
Defined in: bot/src/transformers/types.ts:744
Verification level required for the guild
voiceStates
voiceStates:
Collection
<bigint
,VoiceState
>
Defined in: bot/src/transformers/types.ts:818
States of members currently in voice channels; lacks the guild_id key
welcomeScreen?
optional
welcomeScreen:WelcomeScreen
Defined in: bot/src/transformers/types.ts:834
The welcome screen of a Community guild, shown to new members, returned in an Invite's guild object
widgetChannelId?
optional
widgetChannelId:bigint
Defined in: bot/src/transformers/types.ts:804
The channel id that the widget will generate an invite to, or null if set to no invite
widgetEnabled?
optional
widgetEnabled:boolean
Defined in: bot/src/transformers/types.ts:742
True if the server widget is enabled