GuildToggles

Documentation

---

Documentation / @discordeno/bot / GuildToggles

Class: GuildToggles

Defined in: bot/src/transformers/toggles/guild.ts:119

Extends

• ToggleBitfieldBigint

Constructors

Constructor

new GuildToggles(guildOrTogglesBigint): GuildToggles

Defined in: bot/src/transformers/toggles/guild.ts:120

Parameters

guildOrTogglesBigint

bigint | DiscordGuild

Returns

GuildToggles

Overrides

ToggleBitfieldBigint.constructor

Properties

bitfield

bitfield: bigint = 0n

Defined in: bot/src/transformers/toggles/ToggleBitfield.ts:31

Inherited from

ToggleBitfieldBigint.bitfield

Accessors

animatedBanner

Get Signature

get animatedBanner(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:243

Whether the guild has access to set an animated guild banner image

Returns

boolean

---

animatedIcon

Get Signature

get animatedIcon(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:263

Whether the guild has access to set an animated guild icon

Returns

boolean

---

applicationCommandPermissionsV2

Get Signature

get applicationCommandPermissionsV2(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:318

Whether the guild is using the old permissions configuration behavior

Returns

boolean

---

autoModeration

Get Signature

get autoModeration(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:308

Whether the guild has set up auto moderation rules

Returns

boolean

---

banner

Get Signature

get banner(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:268

Whether the guild has access to set a guild banner image

Returns

boolean

---

community

Get Signature

get community(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:233

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: bot/src/transformers/toggles/guild.ts:323

Whether the guild has enabled monetization.

Returns

boolean

---

creatorStorePage

Get Signature

get creatorStorePage(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:328

Whether the guild has enabled the role subscription promo page.

Returns

boolean

---

developerSupportServer

Get Signature

get developerSupportServer(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:238

Whether the Guild has been set as a support server on the App Directory

Returns

boolean

---

discoverable

Get Signature

get discoverable(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:253

Whether the guild is able to be discovered in the directory

Returns

boolean

---

enhancedRoleColors

Get Signature

get enhancedRoleColors(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:363

Whether the guild is able to set gradient colors to roles

Returns

boolean

---

featurable

Get Signature

get featurable(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:258

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" | "featurable" | "invitesDisabled" | "inviteSplash" | "memberVerificationGateEnabled" | "moreSoundboard" | "moreStickers" | "news" | "partnered" | "previewEnabled" | "raidAlertsDisabled" | "roleIcons" | "roleSubscriptionsAvailableForPurchase" | "roleSubscriptionsEnabled" | "ticketedEventsEnabled" | "vanityUrl" | "verified" | "vipRegions" | "welcomeScreenEnabled" | "guestsEnabled" | "guildTags" | "enhancedRoleColors")[]

Defined in: bot/src/transformers/toggles/guild.ts:170

Returns

("animatedBanner" | "animatedIcon" | "applicationCommandPermissionsV2" | "autoModeration" | "banner" | "community" | "creatorMonetizableProvisional" | "creatorStorePage" | "developerSupportServer" | "discoverable" | "featurable" | "invitesDisabled" | "inviteSplash" | "memberVerificationGateEnabled" | "moreSoundboard" | "moreStickers" | "news" | "partnered" | "previewEnabled" | "raidAlertsDisabled" | "roleIcons" | "roleSubscriptionsAvailableForPurchase" | "roleSubscriptionsEnabled" | "ticketedEventsEnabled" | "vanityUrl" | "verified" | "vipRegions" | "welcomeScreenEnabled" | "guestsEnabled" | "guildTags" | "enhancedRoleColors")[]

---

guestsEnabled

Get Signature

get guestsEnabled(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:353

Whether the guild has access to guest invites

Returns

boolean

---

guildTags

Get Signature

get guildTags(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:358

Whether the guild has access to set guild tags

Returns

boolean

---

invitesDisabled

Get Signature

get invitesDisabled(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:313

Whether the guild has paused invites, preventing new users from joining

Returns

boolean

---

inviteSplash

Get Signature

get inviteSplash(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:208

Whether the guild has access to set an invite splash background

Returns

boolean

---

large

Get Signature

get large(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:193

Whether this is considered a large guild

Returns

boolean

---

memberVerificationGateEnabled

Get Signature

get memberVerificationGateEnabled(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:278

Whether the guild has enabled Membership Screening

Returns

boolean

---

moreSoundboard

Get Signature

get moreSoundboard(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:283

Whether the guild has more soundboard sound slot

Returns

boolean

---

moreStickers

Get Signature

get moreStickers(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:298

Whether the guild has increased custom sticker slots

Returns

boolean

---

news

Get Signature

get news(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:248

Whether the guild has access to create news channels

Returns

boolean

---

owner

Get Signature

get owner(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:183

Whether the bot is the owner of the guild

Returns

boolean

---

partnered

Get Signature

get partnered(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:228

Whether the guild is partnered

Returns

boolean

---

premiumProgressBarEnabled

Get Signature

get premiumProgressBarEnabled(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:203

Whether the guild has the boost progress bar enabled

Returns

boolean

---

previewEnabled

Get Signature

get previewEnabled(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:288

Whether the guild can be previewed before joining via Membership Screening or the directory

Returns

boolean

---

raidAlertsDisabled

Get Signature

get raidAlertsDisabled(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:333

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: bot/src/transformers/toggles/guild.ts:303

Whether the guild is able to set role icons

Returns

boolean

---

roleSubscriptionsAvailableForPurchase

Get Signature

get roleSubscriptionsAvailableForPurchase(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:338

Whether the guild has role subscriptions that can be purchased.

Returns

boolean

---

roleSubscriptionsEnabled

Get Signature

get roleSubscriptionsEnabled(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:343

Whether the guild has enabled role subscriptions.

Returns

boolean

---

soundboard

Get Signature

get soundboard(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:348

Whether the guild has created soundboard sounds.

Returns

boolean

---

ticketedEventsEnabled

Get Signature

get ticketedEventsEnabled(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:293

Whether the guild has enabled ticketed events

Returns

boolean

---

unavailable

Get Signature

get unavailable(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:198

Whether this guild is unavailable due to an outage

Returns

boolean

---

vanityUrl

Get Signature

get vanityUrl(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:218

Whether the guild has access to set a vanity URL

Returns

boolean

---

verified

Get Signature

get verified(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:223

Whether the guild is verified

Returns

boolean

---

vipRegions

Get Signature

get vipRegions(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:213

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: bot/src/transformers/toggles/guild.ts:273

Whether the guild has enabled the welcome screen

Returns

boolean

---

widgetEnabled

Get Signature

get widgetEnabled(): boolean

Defined in: bot/src/transformers/toggles/guild.ts:188

Whether the server widget is enabled

Returns

boolean

Methods

add()

add(bits): this

Defined in: bot/src/transformers/toggles/ToggleBitfield.ts:43

Adds some bits to the bitfield.

Parameters

bits

bigint

Returns

this

Inherited from

ToggleBitfieldBigint.add

---

contains()

contains(bits): boolean

Defined in: bot/src/transformers/toggles/ToggleBitfield.ts:38

Tests whether or not this bitfield has the permission requested.

Parameters

bits

bigint

Returns

boolean

Inherited from

ToggleBitfieldBigint.contains

---

has()

has(permissions): boolean

Defined in: bot/src/transformers/toggles/guild.ts:368

Checks whether or not the permissions exist in this

Parameters

permissions

"animatedBanner" | "animatedIcon" | "applicationCommandPermissionsV2" | "autoModeration" | "banner" | "community" | "creatorMonetizableProvisional" | "creatorStorePage" | "developerSupportServer" | "discoverable" | "featurable" | "invitesDisabled" | "inviteSplash" | "memberVerificationGateEnabled" | "moreSoundboard" | "moreStickers" | "news" | "partnered" | "previewEnabled" | "raidAlertsDisabled" | "roleIcons" | "roleSubscriptionsAvailableForPurchase" | "roleSubscriptionsEnabled" | "ticketedEventsEnabled" | "vanityUrl" | "verified" | "vipRegions" | "welcomeScreenEnabled" | "guestsEnabled" | "guildTags" | "enhancedRoleColors" | "large" | "unavailable" | "owner" | "widgetEnabled" | "premiumProgressBarEnabled" | "soundboard" | ("animatedBanner" | "animatedIcon" | "applicationCommandPermissionsV2" | "autoModeration" | "banner" | "community" | "creatorMonetizableProvisional" | "creatorStorePage" | "developerSupportServer" | "discoverable" | "featurable" | "invitesDisabled" | "inviteSplash" | "memberVerificationGateEnabled" | "moreSoundboard" | "moreStickers" | "news" | "partnered" | "previewEnabled" | "raidAlertsDisabled" | "roleIcons" | "roleSubscriptionsAvailableForPurchase" | "roleSubscriptionsEnabled" | "ticketedEventsEnabled" | "vanityUrl" | "verified" | "vipRegions" | "welcomeScreenEnabled" | "guestsEnabled" | "guildTags" | "enhancedRoleColors" | "large" | "unavailable" | "owner" | "widgetEnabled" | "premiumProgressBarEnabled" | "soundboard")[]

Returns

boolean

---

list()

list(): Record<GuildToggleKeys, boolean>

Defined in: bot/src/transformers/toggles/guild.ts:375

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: bot/src/transformers/toggles/ToggleBitfield.ts:49

Removes some bits from the bitfield.

Parameters

bits

bigint

Returns

this

Inherited from

ToggleBitfieldBigint.remove

---

toJSON()

toJSON(): string

Defined in: bot/src/transformers/toggles/ToggleBitfield.ts:54

Returns

string

Inherited from

ToggleBitfieldBigint.toJSON