UserToggles

Documentation

---

Documentation / @discordeno/bot / UserToggles

Class: UserToggles

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

Extends

• ToggleBitfield

Constructors

Constructor

new UserToggles(userOrTogglesInt): UserToggles

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

Parameters

userOrTogglesInt

number | Partial<DiscordUser>

Returns

UserToggles

Overrides

ToggleBitfield.constructor

Properties

bitfield

bitfield: number = 0

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

Inherited from

ToggleBitfield.bitfield

Accessors

bot

Get Signature

get bot(): boolean

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

Whether the user belongs to an OAuth2 application

Returns

boolean

---

mfaEnabled

Get Signature

get mfaEnabled(): boolean

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

Whether the user has two factor enabled on their account

Returns

boolean

---

system

Get Signature

get system(): boolean

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

Whether the user is an Official Discord System user (part of the urgent message system)

Returns

boolean

---

verified

Get Signature

get verified(): boolean

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

Whether the email on this account has been verified

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

Checks whether or not the permissions exist in this

Parameters

permissions

"verified" | "bot" | "system" | "mfaEnabled" | ("verified" | "bot" | "system" | "mfaEnabled")[]

Returns

boolean

---

list()

list(): Record<UserToggleKeys, boolean>

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

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

Returns

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