Skip to main content

EmojiToggles

@discordeno/botDocs


Documentation / @discordeno/bot / EmojiToggles

Class: EmojiToggles

Extends

Constructors

new EmojiToggles()

new EmojiToggles(roleOrTogglesInt): EmojiToggles

Parameters

roleOrTogglesInt: number | DiscordEmoji

Returns

EmojiToggles

Overrides

ToggleBitfield.constructor

Defined in

packages/bot/src/transformers/toggles/emoji.ts:16

Properties

bitfield

bitfield: number = 0

Inherited from

ToggleBitfield.bitfield

Defined in

packages/bot/src/transformers/toggles/ToggleBitfield.ts:2

Accessors

animated

Get Signature

get animated(): boolean

Whether this emoji is animated

Returns

boolean

Defined in

packages/bot/src/transformers/toggles/emoji.ts:41


available

Get Signature

get available(): boolean

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

Returns

boolean

Defined in

packages/bot/src/transformers/toggles/emoji.ts:46


managed

Get Signature

get managed(): boolean

Whether this emoji is managed

Returns

boolean

Defined in

packages/bot/src/transformers/toggles/emoji.ts:36


requireColons

Get Signature

get requireColons(): boolean

Whether this emoji must be wrapped in colons

Returns

boolean

Defined in

packages/bot/src/transformers/toggles/emoji.ts:31

Methods

add()

add(bits): this

Adds some bits to the bitfield.

Parameters

bits: number

Returns

this

Inherited from

ToggleBitfield.add

Defined in

packages/bot/src/transformers/toggles/ToggleBitfield.ts:14


contains()

contains(bits): boolean

Tests whether or not this bitfield has the permission requested.

Parameters

bits: number

Returns

boolean

Inherited from

ToggleBitfield.contains

Defined in

packages/bot/src/transformers/toggles/ToggleBitfield.ts:9


has()

has(permissions): boolean

Checks whether or not the permissions exist in this

Parameters

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

Returns

boolean

Defined in

packages/bot/src/transformers/toggles/emoji.ts:51


list()

list(): Record<"available" | "managed" | "requireColons" | "animated", boolean>

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

Returns

Record<"available" | "managed" | "requireColons" | "animated", boolean>

Defined in

packages/bot/src/transformers/toggles/emoji.ts:58


remove()

remove(bits): this

Removes some bits from the bitfield.

Parameters

bits: number

Returns

this

Inherited from

ToggleBitfield.remove

Defined in

packages/bot/src/transformers/toggles/ToggleBitfield.ts:20


toJSON()

toJSON(): number

Returns

number

Inherited from

ToggleBitfield.toJSON

Defined in

packages/bot/src/transformers/toggles/ToggleBitfield.ts:25