GuildToggles
@discordeno/bot • Docs
Documentation / @discordeno/bot / GuildToggles
Class: GuildToggles
Extends
Constructors
new GuildToggles()
new GuildToggles(
guildOrTogglesBigint):GuildToggles
Parameters
• guildOrTogglesBigint: bigint | DiscordGuild
Returns
Overrides
ToggleBitfieldBigint.constructor
Defined in
packages/bot/src/transformers/toggles/guild.ts:111
Properties
bitfield
bitfield:
bigint=0n
Inherited from
Defined in
packages/bot/src/transformers/toggles/ToggleBitfield.ts:31
Accessors
animatedBanner
Get Signature
get animatedBanner():
boolean
Whether the guild has access to set an animated guild banner image
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:231
animatedIcon
Get Signature
get animatedIcon():
boolean
Whether the guild has access to set an animated guild icon
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:251
applicationCommandPermissionsV2
Get Signature
get applicationCommandPermissionsV2():
boolean
Whether the guild is using the old permissions configuration behavior
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:306
autoModeration
Get Signature
get autoModeration():
boolean
Whether the guild has set up auto moderation rules
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:296
banner
Get Signature
get banner():
boolean
Whether the guild has access to set a guild banner image
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:256
community
Get Signature
get community():
boolean
Whether the guild can enable welcome screen, Membership Screening, stage channels and discovery, and receives community updates
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:221
creatorMonetizableProvisional
Get Signature
get creatorMonetizableProvisional():
boolean
Whether the guild has enabled monetization.
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:311
creatorStorePage
Get Signature
get creatorStorePage():
boolean
Whether the guild has enabled the role subscription promo page.
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:316
developerSupportServer
Get Signature
get developerSupportServer():
boolean
Whether the Guild has been set as a support server on the App Directory
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:226
discoverable
Get Signature
get discoverable():
boolean
Whether the guild is able to be discovered in the directory
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:241
featurable
Get Signature
get featurable():
boolean
Whether the guild is able to be featured in the directory
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:246
features
Get Signature
get 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")[]
Returns
("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
packages/bot/src/transformers/toggles/guild.ts:158
invitesDisabled
Get Signature
get invitesDisabled():
boolean
Whether the guild has paused invites, preventing new users from joining
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:301
inviteSplash
Get Signature
get inviteSplash():
boolean
Whether the guild has access to set an invite splash background
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:196
large
Get Signature
get large():
boolean
Whether this is considered a large guild
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:181
memberVerificationGateEnabled
Get Signature
get memberVerificationGateEnabled():
boolean
Whether the guild has enabled Membership Screening
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:266
moreSoundboard
Get Signature
get moreSoundboard():
boolean
Whether the guild has more soundboard sound slot
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:271
moreStickers
Get Signature
get moreStickers():
boolean
Whether the guild has increased custom sticker slots
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:286
news
Get Signature
get news():
boolean
Whether the guild has access to create news channels
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:236
owner
Get Signature
get owner():
boolean
Whether the bot is the owner of the guild
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:171
partnered
Get Signature
get partnered():
boolean
Whether the guild is partnered
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:216
premiumProgressBarEnabled
Get Signature
get premiumProgressBarEnabled():
boolean
Whether the guild has the boost progress bar enabled
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:191
previewEnabled
Get Signature
get previewEnabled():
boolean
Whether the guild can be previewed before joining via Membership Screening or the directory
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:276
raidAlertsDisabled
Get Signature
get raidAlertsDisabled():
boolean
Whether the guild has disabled alerts for join raids in the configured safety alerts channel
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:321
roleIcons
Get Signature
get roleIcons():
boolean
Whether the guild is able to set role icons
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:291
roleSubscriptionsAvailableForPurchase
Get Signature
get roleSubscriptionsAvailableForPurchase():
boolean
Whether the guild has role subscriptions that can be purchased.
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:326
roleSubscriptionsEnabled
Get Signature
get roleSubscriptionsEnabled():
boolean
Whether the guild has enabled role subscriptions.
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:331
soundboard
Get Signature
get soundboard():
boolean
Whether the guild has created soundboard sounds.
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:336
ticketedEventsEnabled
Get Signature
get ticketedEventsEnabled():
boolean
Whether the guild has enabled ticketed events
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:281
unavailable
Get Signature
get unavailable():
boolean
Whether this guild is unavailable due to an outage
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:186
vanityUrl
Get Signature
get vanityUrl():
boolean
Whether the guild has access to set a vanity URL
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:206
verified
Get Signature
get verified():
boolean
Whether the guild is verified
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:211
vipRegions
Get Signature
get vipRegions():
boolean
Whether the guild has access to set 384 kbps bitrate in voice (previously VIP voice servers)
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:201
welcomeScreenEnabled
Get Signature
get welcomeScreenEnabled():
boolean
Whether the guild has enabled the welcome screen
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:261
widgetEnabled
Get Signature
get widgetEnabled():
boolean
Whether the server widget is enabled
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:176
Methods
add()
add(
bits):this
Adds some bits to the bitfield.
Parameters
• bits: bigint
Returns
this
Inherited from
Defined in
packages/bot/src/transformers/toggles/ToggleBitfield.ts:43
contains()
contains(
bits):boolean
Tests whether or not this bitfield has the permission requested.
Parameters
• bits: bigint
Returns
boolean
Inherited from
Defined in
packages/bot/src/transformers/toggles/ToggleBitfield.ts:38
has()
has(
permissions):boolean
Checks whether or not the permissions exist in this
Parameters
• permissions: "owner" | "widgetEnabled" | "large" | "unavailable" | "premiumProgressBarEnabled" | "banner" | "verified" | "soundboard" | "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" | ("owner" | "widgetEnabled" | "large" | "unavailable" | "premiumProgressBarEnabled" | "banner" | "verified" | "soundboard" | "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")[]
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/guild.ts:341
list()
list():
Record<"owner"|"widgetEnabled"|"large"|"unavailable"|"premiumProgressBarEnabled"|"banner"|"verified"|"soundboard"|"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",boolean>
Lists all the toggles for the role and whether or not each is true or false.
Returns
Record<"owner" | "widgetEnabled" | "large" | "unavailable" | "premiumProgressBarEnabled" | "banner" | "verified" | "soundboard" | "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", boolean>
Defined in
packages/bot/src/transformers/toggles/guild.ts:348
remove()
remove(
bits):this
Removes some bits from the bitfield.
Parameters
• bits: bigint
Returns
this
Inherited from
Defined in
packages/bot/src/transformers/toggles/ToggleBitfield.ts:49
toJSON()
toJSON():
string
Returns
string