Guild
Defined in: packages/structures/src/base.ts:401
Common Discord snowflake-backed structure.
Extends
Section titled âExtendsâConstructors
Section titled âConstructorsâConstructor
Section titled âConstructorânew Guild(
data):Guild
Defined in: packages/structures/src/base.ts:454
Parameters
Section titled âParametersâReturns
Section titled âReturnsâGuild
Overrides
Section titled âOverridesâProperties
Section titled âPropertiesâafkChannelId
Section titled âafkChannelIdâafkChannelId:
string|null
Defined in: packages/structures/src/base.ts:434
AFK voice channel, or null.
afkTimeout?
Section titled âafkTimeout?â
optionalafkTimeout?:number
Defined in: packages/structures/src/base.ts:436
Seconds before a silent member is moved to the AFK channel.
applicationId
Section titled âapplicationIdâapplicationId:
string|null
Defined in: packages/structures/src/base.ts:442
Application that created the guild, if a bot did.
approximateMemberCount?
Section titled âapproximateMemberCount?â
optionalapproximateMemberCount?:number
Defined in: packages/structures/src/base.ts:414
approximatePresenceCount?
Section titled âapproximatePresenceCount?â
optionalapproximatePresenceCount?:number
Defined in: packages/structures/src/base.ts:415
banner:
string|null
Defined in: packages/structures/src/base.ts:405
defaultMessageNotifications
Section titled âdefaultMessageNotificationsâdefaultMessageNotifications:
number
Defined in: packages/structures/src/base.ts:432
Default notification level for new members.
description
Section titled âdescriptionâdescription:
string|null
Defined in: packages/structures/src/base.ts:406
discoverySplash
Section titled âdiscoverySplashâdiscoverySplash:
string|null
Defined in: packages/structures/src/base.ts:418
explicitContentFilter
Section titled âexplicitContentFilterâexplicitContentFilter:
number
Defined in: packages/structures/src/base.ts:430
Explicit content filter level.
features
Section titled âfeaturesâfeatures:
string[]
Defined in: packages/structures/src/base.ts:409
icon:
string|null
Defined in: packages/structures/src/base.ts:403
readonlyid:string
Defined in: packages/structures/src/base.ts:12
Inherited from
Section titled âInherited fromâmaxMembers
Section titled âmaxMembersâmaxMembers:
number
Defined in: packages/structures/src/base.ts:426
Maximum number of members the guild can have.
maxPresences
Section titled âmaxPresencesâmaxPresences:
number|null
Defined in: packages/structures/src/base.ts:448
Maximum presences (null for the default limit).
maxVideoChannelUsers?
Section titled âmaxVideoChannelUsers?â
optionalmaxVideoChannelUsers?:number
Defined in: packages/structures/src/base.ts:450
Maximum users in a video channel.
memberCount?
Section titled âmemberCount?â
optionalmemberCount?:number
Defined in: packages/structures/src/base.ts:413
mfaLevel
Section titled âmfaLevelâmfaLevel:
number
Defined in: packages/structures/src/base.ts:428
Required MFA level for administrators.
name:
string
Defined in: packages/structures/src/base.ts:402
nsfwLevel
Section titled ânsfwLevelânsfwLevel:
number
Defined in: packages/structures/src/base.ts:417
ownerId?
Section titled âownerId?â
optionalownerId?:string
Defined in: packages/structures/src/base.ts:408
preferredLocale
Section titled âpreferredLocaleâpreferredLocale:
string
Defined in: packages/structures/src/base.ts:407
premiumProgressBarEnabled
Section titled âpremiumProgressBarEnabledâpremiumProgressBarEnabled:
boolean
Defined in: packages/structures/src/base.ts:452
Whether the boost progress bar shows.
premiumSubscriptionCount
Section titled âpremiumSubscriptionCountâpremiumSubscriptionCount:
number
Defined in: packages/structures/src/base.ts:412
premiumTier
Section titled âpremiumTierâpremiumTier:
number
Defined in: packages/structures/src/base.ts:411
publicUpdatesChannelId
Section titled âpublicUpdatesChannelIdâpublicUpdatesChannelId:
string|null
Defined in: packages/structures/src/base.ts:444
Channel for Discordâs community updates, or null.
rulesChannelId
Section titled ârulesChannelIdârulesChannelId:
string|null
Defined in: packages/structures/src/base.ts:420
ID of the rules channel for Community guilds.
safetyAlertsChannelId
Section titled âsafetyAlertsChannelIdâsafetyAlertsChannelId:
string|null
Defined in: packages/structures/src/base.ts:446
Channel for safety alerts, or null.
splash:
string|null
Defined in: packages/structures/src/base.ts:404
systemChannelFlags
Section titled âsystemChannelFlagsâsystemChannelFlags:
number
Defined in: packages/structures/src/base.ts:424
Bitfield of system channel flags.
systemChannelId
Section titled âsystemChannelIdâsystemChannelId:
string|null
Defined in: packages/structures/src/base.ts:422
ID of the system messages channel.
vanityUrlCode
Section titled âvanityUrlCodeâvanityUrlCode:
string|null
Defined in: packages/structures/src/base.ts:416
verificationLevel
Section titled âverificationLevelâverificationLevel:
number
Defined in: packages/structures/src/base.ts:410
widgetChannelId
Section titled âwidgetChannelIdâwidgetChannelId:
string|null
Defined in: packages/structures/src/base.ts:440
Channel the widget invites to, or null.
widgetEnabled
Section titled âwidgetEnabledâwidgetEnabled:
boolean
Defined in: packages/structures/src/base.ts:438
Whether the server widget is on.
Accessors
Section titled âAccessorsâboostLevel
Section titled âboostLevelâGet Signature
Section titled âGet Signatureâget boostLevel():
number
Defined in: packages/structures/src/base.ts:559
Alias for premiumTier â the guildâs current Nitro boost level (0â3).
Returns
Section titled âReturnsânumber
createdAt
Section titled âcreatedAtâGet Signature
Section titled âGet Signatureâget createdAt():
Date
Defined in: packages/structures/src/base.ts:29
Returns the timestamp this snowflake was created at.
Returns
Section titled âReturnsâDate
Inherited from
Section titled âInherited fromâcreatedTimestamp
Section titled âcreatedTimestampâGet Signature
Section titled âGet Signatureâget createdTimestamp():
number
Defined in: packages/structures/src/base.ts:25
Milliseconds since the Unix epoch at which this snowflake was created.
Returns
Section titled âReturnsânumber
Inherited from
Section titled âInherited fromâBaseStructure.createdTimestamp
hasVanityUrl
Section titled âhasVanityUrlâGet Signature
Section titled âGet Signatureâget hasVanityUrl():
boolean
Defined in: packages/structures/src/base.ts:564
Whether the guild has a vanity URL.
Returns
Section titled âReturnsâboolean
isBoosted
Section titled âisBoostedâGet Signature
Section titled âGet Signatureâget isBoosted():
boolean
Defined in: packages/structures/src/base.ts:554
Whether the guild has any active boost subscriptions.
Returns
Section titled âReturnsâboolean
isCommunity
Section titled âisCommunityâGet Signature
Section titled âGet Signatureâget isCommunity():
boolean
Defined in: packages/structures/src/base.ts:539
Whether the guild is a Community server.
Returns
Section titled âReturnsâboolean
isPartnered
Section titled âisPartneredâGet Signature
Section titled âGet Signatureâget isPartnered():
boolean
Defined in: packages/structures/src/base.ts:544
Whether the guild is an official Discord Partner.
Returns
Section titled âReturnsâboolean
isVerified
Section titled âisVerifiedâGet Signature
Section titled âGet Signatureâget isVerified():
boolean
Defined in: packages/structures/src/base.ts:549
Whether the guild is verified by Discord.
Returns
Section titled âReturnsâboolean
vanityURL
Section titled âvanityURLâGet Signature
Section titled âGet Signatureâget vanityURL():
string|null
Defined in: packages/structures/src/base.ts:569
Returns the guildâs vanity invite URL, or null if none.
Returns
Section titled âReturnsâstring | null
Methods
Section titled âMethodsâbannerURL()
Section titled âbannerURL()âbannerURL(
options?):string|null
Defined in: packages/structures/src/base.ts:508
Returns the guild banner URL, or null if none.
Parameters
Section titled âParametersâoptions?
Section titled âoptions?âImageURLOptions = {}
Returns
Section titled âReturnsâstring | null
discoverySplashURL()
Section titled âdiscoverySplashURL()âdiscoverySplashURL(
options?):string|null
Defined in: packages/structures/src/base.ts:514
Returns the guild discovery splash URL, or null if none.
Parameters
Section titled âParametersâoptions?
Section titled âoptions?âImageURLOptions = {}
Returns
Section titled âReturnsâstring | null
hasFeature()
Section titled âhasFeature()âhasFeature(
feature):boolean
Defined in: packages/structures/src/base.ts:534
Whether the guild has a given feature flag.
Parameters
Section titled âParametersâfeature
Section titled âfeatureâstring
Feature string, e.g. âCOMMUNITYâ.
Returns
Section titled âReturnsâboolean
iconURL()
Section titled âiconURL()âiconURL(
options?):string|null
Defined in: packages/structures/src/base.ts:496
Returns the guild icon URL, or null if no icon is set.
Parameters
Section titled âParametersâoptions?
Section titled âoptions?âImageURLOptions = {}
Returns
Section titled âReturnsâstring | null
splashURL()
Section titled âsplashURL()âsplashURL(
options?):string|null
Defined in: packages/structures/src/base.ts:502
Returns the guild splash URL, or null if none.
Parameters
Section titled âParametersâoptions?
Section titled âoptions?âImageURLOptions = {}
Returns
Section titled âReturnsâstring | null
toString()
Section titled âtoString()âtoString():
string
Defined in: packages/structures/src/base.ts:576
Returns a human-readable string representation.
Returns
Section titled âReturnsâstring
Overrides
Section titled âOverridesâwidgetImageURL()
Section titled âwidgetImageURL()âwidgetImageURL(
style?):string
Defined in: packages/structures/src/base.ts:526
Returns a widget image URL for the guild.
Parameters
Section titled âParametersâ"shield" | "banner1" | "banner2" | "banner3" | "banner4"
Widget style: shield (default), banner1, banner2, banner3, banner4.
Returns
Section titled âReturnsâstring