EmojiToggles

Documentation

---

Documentation / @discordeno/bot / EmojiToggles

Class: EmojiToggles

Defined in: transformers/toggles/emoji.ts:15

Extends

• ToggleBitfield

Constructors

Constructor

new EmojiToggles(roleOrTogglesInt): EmojiToggles

Defined in: transformers/toggles/emoji.ts:16

Parameters

roleOrTogglesInt

number | Partial<DiscordEmoji>

Returns

EmojiToggles

Overrides

ToggleBitfield.constructor

Properties

bitfield

bitfield: number = 0

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

Inherited from

ToggleBitfield.bitfield

Accessors

animated

Get Signature

get animated(): boolean

Defined in: transformers/toggles/emoji.ts:41

Whether this emoji is animated

Returns

boolean

---

available

Get Signature

get available(): boolean

Defined in: transformers/toggles/emoji.ts:46

Whether this emoji can be used, may be false due to loss of Server Boosts

Returns

boolean

---

managed

Get Signature

get managed(): boolean

Defined in: transformers/toggles/emoji.ts:36

Whether this emoji is managed

Returns

boolean

---

requireColons

Get Signature

get requireColons(): boolean

Defined in: transformers/toggles/emoji.ts:31

Whether this emoji must be wrapped in colons

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/emoji.ts:51

Checks whether or not the permissions exist in this

Parameters

permissions

"managed" | "animated" | "available" | "requireColons" | ("managed" | "animated" | "available" | "requireColons")[]

Returns

boolean

---

list()

list(): Record<EmojiToggleKeys, boolean>

Defined in: transformers/toggles/emoji.ts:58

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

Returns

Record<EmojiToggleKeys, 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