MemberToggles

Documentation

---

Documentation / @discordeno/bot / MemberToggles

Class: MemberToggles

Defined in: transformers/toggles/member.ts:39

Extends

• ToggleBitfield

Constructors

Constructor

new MemberToggles(memberOrTogglesInt): MemberToggles

Defined in: transformers/toggles/member.ts:40

Parameters

memberOrTogglesInt

number | Partial<DiscordMember>

Returns

MemberToggles

Overrides

ToggleBitfield.constructor

Properties

bitfield

bitfield: number = 0

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

Inherited from

ToggleBitfield.bitfield

Accessors

automodQuarantinedGuildTag

Get Signature

get automodQuarantinedGuildTag(): boolean

Defined in: transformers/toggles/member.ts:144

Member's guild tag is blocked by AutoMod

Returns

boolean

---

automodQuarantinedUsername

Get Signature

get automodQuarantinedUsername(): boolean

Defined in: transformers/toggles/member.ts:134

Member's username, display name, or nickname is blocked by AutoMod

Returns

boolean

---

bypassesVerification

Get Signature

get bypassesVerification(): boolean

Defined in: transformers/toggles/member.ts:109

Member is exempt from guild verification requirements

Returns

boolean

---

completedHomeActions

Get Signature

get completedHomeActions(): boolean

Defined in: transformers/toggles/member.ts:129

Member has completed Server Guide new member actions

Returns

boolean

---

completedOnboarding

Get Signature

get completedOnboarding(): boolean

Defined in: transformers/toggles/member.ts:114

Member has started onboarding

Returns

boolean

---

deaf

Get Signature

get deaf(): boolean

Defined in: transformers/toggles/member.ts:84

Whether the user belongs to an OAuth2 application

Returns

boolean

---

didRejoin

Get Signature

get didRejoin(): boolean

Defined in: transformers/toggles/member.ts:99

Member has left and rejoined the guild

Returns

boolean

---

dmSettingsUpsellAcknowledged

Get Signature

get dmSettingsUpsellAcknowledged(): boolean

Defined in: transformers/toggles/member.ts:139

Member has dismissed the DM settings upsell

Returns

boolean

---

flags

Get Signature

get flags(): number

Defined in: transformers/toggles/member.ts:66

Returns

number

---

isGuest

Get Signature

get isGuest(): boolean

Defined in: transformers/toggles/member.ts:119

Member is a guest and can only access the voice channel they were invited to

Returns

boolean

---

mute

Get Signature

get mute(): boolean

Defined in: transformers/toggles/member.ts:89

Whether the user is muted in voice channels

Returns

boolean

---

pending

Get Signature

get pending(): boolean

Defined in: transformers/toggles/member.ts:94

Whether the user has not yet passed the guild's Membership Screening requirements

Returns

boolean

---

startedHomeActions

Get Signature

get startedHomeActions(): boolean

Defined in: transformers/toggles/member.ts:124

Member has started Server Guide new member actions

Returns

boolean

---

startedOnboarding

Get Signature

get startedOnboarding(): boolean

Defined in: transformers/toggles/member.ts:104

Member has completed onboarding

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/member.ts:149

Checks whether or not the permissions exist in this

Parameters

permissions

"didRejoin" | "startedOnboarding" | "bypassesVerification" | "completedOnboarding" | "deaf" | "mute" | "pending" | "isGuest" | "startedHomeActions" | "completedHomeActions" | "automodQuarantinedUsername" | "dmSettingsUpsellAcknowledged" | "automodQuarantinedGuildTag" | ("didRejoin" | "startedOnboarding" | "bypassesVerification" | "completedOnboarding" | "deaf" | "mute" | "pending" | "isGuest" | "startedHomeActions" | "completedHomeActions" | "automodQuarantinedUsername" | "dmSettingsUpsellAcknowledged" | "automodQuarantinedGuildTag")[]

Returns

boolean

---

list()

list(): Record<MemberToggleKeys, boolean>

Defined in: transformers/toggles/member.ts:156

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

Returns

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