GuildToggles
Documentation / @discordeno/bot / GuildToggles
Class: GuildToggles
Defined in: transformers/toggles/guild.ts:122
Extends
Constructors
Constructor
new GuildToggles(
guildOrTogglesBigint):GuildToggles
Defined in: transformers/toggles/guild.ts:123
Parameters
guildOrTogglesBigint
bigint | Partial<DiscordGuild>
Returns
GuildToggles
Overrides
ToggleBitfieldBigint.constructor
Properties
bitfield
bitfield:
bigint=0n
Defined in: transformers/toggles/ToggleBitfield.ts:31
Inherited from
Accessors
animatedBanner
Get Signature
get animatedBanner():
boolean
Defined in: transformers/toggles/guild.ts:247
Whether the guild has access to set an animated guild banner image
Returns
boolean
animatedIcon
Get Signature
get animatedIcon():
boolean
Defined in: transformers/toggles/guild.ts:282
Whether the guild has access to set an animated guild icon
Returns
boolean
applicationCommandPermissionsV2
Get Signature
get applicationCommandPermissionsV2():
boolean
Defined in: transformers/toggles/guild.ts:341
Whether the guild is using the old permissions configuration behavior
Returns
boolean
autoModeration
Get Signature
get autoModeration():
boolean
Defined in: transformers/toggles/guild.ts:331
Whether the guild has set up auto moderation rules
Returns
boolean
banner
Get Signature
get banner():
boolean
Defined in: transformers/toggles/guild.ts:287
Whether the guild has access to set a guild banner image
Returns
boolean
community
Get Signature
get community():
boolean
Defined in: transformers/toggles/guild.ts:237
Whether the guild can enable welcome screen, Membership Screening, stage channels and discovery, and receives community updates
Returns
boolean
creatorMonetizableProvisional
Get Signature
get creatorMonetizableProvisional():
boolean
Defined in: transformers/toggles/guild.ts:346
Whether the guild has enabled monetization.
Returns
boolean
creatorStorePage
Get Signature
get creatorStorePage():
boolean
Defined in: transformers/toggles/guild.ts:351
Whether the guild has enabled the role subscription promo page.
Returns
boolean
developerSupportServer
Get Signature
get developerSupportServer():
boolean
Defined in: transformers/toggles/guild.ts:242
Whether the Guild has been set as a support server on the App Directory
Returns
boolean
discoverable
Get Signature
get discoverable():
boolean
Defined in: transformers/toggles/guild.ts:257
Whether the guild is able to be discovered in the directory
Returns
boolean
enhancedRoleColors
Get Signature
get enhancedRoleColors():
boolean
Defined in: transformers/toggles/guild.ts:262
Whether the guild is able to set gradient colors to roles
Returns
boolean
featurable
Get Signature
get featurable():
boolean
Defined in: transformers/toggles/guild.ts:267
Whether the guild is able to be featured in the directory
Returns
boolean
features
Get Signature
get features(): (
"animatedBanner"|"animatedIcon"|"applicationCommandPermissionsV2"|"autoModeration"|"banner"|"community"|"creatorMonetizableProvisional"|"creatorStorePage"|"developerSupportServer"|"discoverable"|"enhancedRoleColors"|"featurable"|"guildTags"|"guestsEnabled"|"invitesDisabled"|"inviteSplash"|"memberVerificationGateEnabled"|"moreSoundboard"|"moreStickers"|"news"|"partnered"|"previewEnabled"|"pruneRequiresAdmin"|"raidAlertsDisabled"|"roleIcons"|"roleSubscriptionsAvailableForPurchase"|"roleSubscriptionsEnabled"|"ticketedEventsEnabled"|"vanityUrl"|"verified"|"vipRegions"|"welcomeScreenEnabled")[]
Defined in: transformers/toggles/guild.ts:174
Returns
("animatedBanner" | "animatedIcon" | "applicationCommandPermissionsV2" | "autoModeration" | "banner" | "community" | "creatorMonetizableProvisional" | "creatorStorePage" | "developerSupportServer" | "discoverable" | "enhancedRoleColors" | "featurable" | "guildTags" | "guestsEnabled" | "invitesDisabled" | "inviteSplash" | "memberVerificationGateEnabled" | "moreSoundboard" | "moreStickers" | "news" | "partnered" | "previewEnabled" | "pruneRequiresAdmin" | "raidAlertsDisabled" | "roleIcons" | "roleSubscriptionsAvailableForPurchase" | "roleSubscriptionsEnabled" | "ticketedEventsEnabled" | "vanityUrl" | "verified" | "vipRegions" | "welcomeScreenEnabled")[]
guestsEnabled
Get Signature
get guestsEnabled():
boolean
Defined in: transformers/toggles/guild.ts:277
Whether the guild has access to guest invites
Returns
boolean
guildTags
Get Signature
get guildTags():
boolean
Defined in: transformers/toggles/guild.ts:272
Whether the guild has access to set guild tags
Returns
boolean
invitesDisabled
Get Signature
get invitesDisabled():
boolean
Defined in: transformers/toggles/guild.ts:336
Whether the guild has paused invites, preventing new users from joining
Returns
boolean
inviteSplash
Get Signature
get inviteSplash():
boolean
Defined in: transformers/toggles/guild.ts:212
Whether the guild has access to set an invite splash background
Returns
boolean
large
Get Signature
get large():
boolean
Defined in: transformers/toggles/guild.ts:197
Whether this is considered a large guild
Returns
boolean
memberVerificationGateEnabled
Get Signature
get memberVerificationGateEnabled():
boolean
Defined in: transformers/toggles/guild.ts:297
Whether the guild has enabled Membership Screening
Returns
boolean
moreSoundboard
Get Signature
get moreSoundboard():
boolean
Defined in: transformers/toggles/guild.ts:302
Whether the guild has more soundboard sound slot
Returns
boolean
moreStickers
Get Signature
get moreStickers():
boolean
Defined in: transformers/toggles/guild.ts:321
Whether the guild has increased custom sticker slots
Returns
boolean
news
Get Signature
get news():
boolean
Defined in: transformers/toggles/guild.ts:252
Whether the guild has access to create news channels
Returns
boolean
owner
Get Signature
get owner():
boolean
Defined in: transformers/toggles/guild.ts:187
Whether the bot is the owner of the guild
Returns
boolean
partnered
Get Signature
get partnered():
boolean
Defined in: transformers/toggles/guild.ts:232
Whether the guild is partnered
Returns
boolean
premiumProgressBarEnabled
Get Signature
get premiumProgressBarEnabled():
boolean
Defined in: transformers/toggles/guild.ts:207
Whether the guild has the boost progress bar enabled
Returns
boolean
previewEnabled
Get Signature
get previewEnabled():
boolean
Defined in: transformers/toggles/guild.ts:307
Whether the guild can be previewed before joining via Membership Screening or the directory
Returns
boolean
pruneRequiresAdmin
Get Signature
get pruneRequiresAdmin():
boolean
Defined in: transformers/toggles/guild.ts:311
Returns
boolean
raidAlertsDisabled
Get Signature
get raidAlertsDisabled():
boolean
Defined in: transformers/toggles/guild.ts:356
Whether the guild has disabled alerts for join raids in the configured safety alerts channel
Returns
boolean
roleIcons
Get Signature
get roleIcons():
boolean
Defined in: transformers/toggles/guild.ts:326
Whether the guild is able to set role icons
Returns
boolean
roleSubscriptionsAvailableForPurchase
Get Signature
get roleSubscriptionsAvailableForPurchase():
boolean
Defined in: transformers/toggles/guild.ts:361
Whether the guild has role subscriptions that can be purchased.
Returns
boolean
roleSubscriptionsEnabled
Get Signature
get roleSubscriptionsEnabled():
boolean
Defined in: transformers/toggles/guild.ts:366
Whether the guild has enabled role subscriptions.
Returns
boolean
soundboard
Get Signature
get soundboard():
boolean
Defined in: transformers/toggles/guild.ts:371
Whether the guild has created soundboard sounds.
Returns
boolean
ticketedEventsEnabled
Get Signature
get ticketedEventsEnabled():
boolean
Defined in: transformers/toggles/guild.ts:316
Whether the guild has enabled ticketed events
Returns
boolean
unavailable
Get Signature
get unavailable():
boolean
Defined in: transformers/toggles/guild.ts:202
Whether this guild is unavailable due to an outage
Returns
boolean
vanityUrl
Get Signature
get vanityUrl():
boolean
Defined in: transformers/toggles/guild.ts:222
Whether the guild has access to set a vanity URL
Returns
boolean
verified
Get Signature
get verified():
boolean
Defined in: transformers/toggles/guild.ts:227
Whether the guild is verified
Returns
boolean
vipRegions
Get Signature
get vipRegions():
boolean
Defined in: transformers/toggles/guild.ts:217
Whether the guild has access to set 384 kbps bitrate in voice (previously VIP voice servers)
Returns
boolean
welcomeScreenEnabled
Get Signature
get welcomeScreenEnabled():
boolean
Defined in: transformers/toggles/guild.ts:292
Whether the guild has enabled the welcome screen
Returns
boolean
widgetEnabled
Get Signature
get widgetEnabled():
boolean
Defined in: transformers/toggles/guild.ts:192
Whether the server widget is enabled
Returns
boolean
Methods
add()
add(
bits):this
Defined in: transformers/toggles/ToggleBitfield.ts:43
Adds some bits to the bitfield.
Parameters
bits
bigint
Returns
this
Inherited from
contains()
contains(
bits):boolean
Defined in: transformers/toggles/ToggleBitfield.ts:38
Tests whether or not this bitfield has the permission requested.
Parameters
bits
bigint
Returns
boolean
Inherited from
has()
has(
permissions):boolean
Defined in: transformers/toggles/guild.ts:376
Checks whether or not the permissions exist in this
Parameters
permissions
"animatedBanner" | "animatedIcon" | "applicationCommandPermissionsV2" | "autoModeration" | "banner" | "community" | "creatorMonetizableProvisional" | "creatorStorePage" | "developerSupportServer" | "discoverable" | "enhancedRoleColors" | "featurable" | "guildTags" | "guestsEnabled" | "invitesDisabled" | "inviteSplash" | "memberVerificationGateEnabled" | "moreSoundboard" | "moreStickers" | "news" | "partnered" | "previewEnabled" | "pruneRequiresAdmin" | "raidAlertsDisabled" | "roleIcons" | "roleSubscriptionsAvailableForPurchase" | "roleSubscriptionsEnabled" | "ticketedEventsEnabled" | "vanityUrl" | "verified" | "vipRegions" | "welcomeScreenEnabled" | "large" | "unavailable" | "owner" | "widgetEnabled" | "premiumProgressBarEnabled" | "soundboard" | ("animatedBanner" | "animatedIcon" | "applicationCommandPermissionsV2" | "autoModeration" | "banner" | "community" | "creatorMonetizableProvisional" | "creatorStorePage" | "developerSupportServer" | "discoverable" | "enhancedRoleColors" | "featurable" | "guildTags" | "guestsEnabled" | "invitesDisabled" | "inviteSplash" | "memberVerificationGateEnabled" | "moreSoundboard" | "moreStickers" | "news" | "partnered" | "previewEnabled" | "pruneRequiresAdmin" | "raidAlertsDisabled" | "roleIcons" | "roleSubscriptionsAvailableForPurchase" | "roleSubscriptionsEnabled" | "ticketedEventsEnabled" | "vanityUrl" | "verified" | "vipRegions" | "welcomeScreenEnabled" | "large" | "unavailable" | "owner" | "widgetEnabled" | "premiumProgressBarEnabled" | "soundboard")[]
Returns
boolean
list()
list():
Record<GuildToggleKeys,boolean>
Defined in: transformers/toggles/guild.ts:383
Lists all the toggles for the role and whether or not each is true or false.
Returns
Record<GuildToggleKeys, boolean>
remove()
remove(
bits):this
Defined in: transformers/toggles/ToggleBitfield.ts:49
Removes some bits from the bitfield.
Parameters
bits
bigint
Returns
this
Inherited from
toJSON()
toJSON():
string
Defined in: transformers/toggles/ToggleBitfield.ts:54
Returns
string