RoleToggles

Documentation

---

Documentation / @discordeno/bot / RoleToggles

Class: RoleToggles

Defined in: transformers/toggles/role.ts:19

Extends

• ToggleBitfield

Constructors

Constructor

new RoleToggles(roleOrTogglesInt): RoleToggles

Defined in: transformers/toggles/role.ts:20

Parameters

roleOrTogglesInt

number | Partial<DiscordRole>

Returns

RoleToggles

Overrides

ToggleBitfield.constructor

Properties

bitfield

bitfield: number = 0

Defined in: transformers/toggles/ToggleBitfield.ts:2

Inherited from

ToggleBitfield.bitfield

Accessors

availableForPurchase

Get Signature

get availableForPurchase(): boolean

Defined in: transformers/toggles/role.ts:57

Whether this role is available for purchase.

Returns

boolean

---

guildConnections

Get Signature

get guildConnections(): boolean

Defined in: transformers/toggles/role.ts:62

Whether this is a guild's linked role.

Returns

boolean

---

hoist

Get Signature

get hoist(): boolean

Defined in: transformers/toggles/role.ts:37

If this role is showed separately in the user listing

Returns

boolean

---

managed

Get Signature

get managed(): boolean

Defined in: transformers/toggles/role.ts:42

Whether this role is managed by an integration

Returns

boolean

---

mentionable

Get Signature

get mentionable(): boolean

Defined in: transformers/toggles/role.ts:47

Whether this role is mentionable

Returns

boolean

---

premiumSubscriber

Get Signature

get premiumSubscriber(): boolean

Defined in: transformers/toggles/role.ts:52

Whether this is the guilds premium subscriber role

Returns

boolean

Methods

add()

add(bits): this

Defined in: transformers/toggles/ToggleBitfield.ts:14

Adds some bits to the bitfield.

Parameters

bits

number

Returns

this

Inherited from

ToggleBitfield.add

---

contains()

contains(bits): boolean

Defined in: transformers/toggles/ToggleBitfield.ts:9

Tests whether or not this bitfield has the permission requested.

Parameters

bits

number

Returns

boolean

Inherited from

ToggleBitfield.contains

---

has()

has(permissions): boolean

Defined in: transformers/toggles/role.ts:67

Checks whether or not the permissions exist in this

Parameters

permissions

"managed" | "hoist" | "mentionable" | "premiumSubscriber" | "availableForPurchase" | "guildConnections" | ("managed" | "hoist" | "mentionable" | "premiumSubscriber" | "availableForPurchase" | "guildConnections")[]

Returns

boolean

---

list()

list(): Record<RoleToggleKeys, boolean>

Defined in: transformers/toggles/role.ts:74

Lists all the toggles for the role and whether or not each is true or false.

Returns

Record<RoleToggleKeys, boolean>

---

remove()

remove(bits): this

Defined in: transformers/toggles/ToggleBitfield.ts:20

Removes some bits from the bitfield.

Parameters

bits

number

Returns

this

Inherited from

ToggleBitfield.remove

---

toJSON()

toJSON(): number

Defined in: transformers/toggles/ToggleBitfield.ts:25

Returns

number

Inherited from

ToggleBitfield.toJSON