MemberToggles
Documentation / @discordeno/bot / MemberToggles
Class: MemberToggles
Defined in: bot/src/transformers/toggles/member.ts:38
Extends
Constructors
Constructor
new MemberToggles(
memberOrTogglesInt):MemberToggles
Defined in: bot/src/transformers/toggles/member.ts:39
Parameters
memberOrTogglesInt
number | Partial<DiscordMember>
Returns
MemberToggles
Overrides
Properties
bitfield
bitfield:
number=0
Defined in: bot/src/transformers/toggles/ToggleBitfield.ts:2
Inherited from
Accessors
automodQuarantinedGuildTag
Get Signature
get automodQuarantinedGuildTag():
boolean
Defined in: bot/src/transformers/toggles/member.ts:143
Member's guild tag is blocked by AutoMod
Returns
boolean
automodQuarantinedUsername
Get Signature
get automodQuarantinedUsername():
boolean
Defined in: bot/src/transformers/toggles/member.ts:133
Member's username, display name, or nickname is blocked by AutoMod
Returns
boolean
bypassesVerification
Get Signature
get bypassesVerification():
boolean
Defined in: bot/src/transformers/toggles/member.ts:108
Member is exempt from guild verification requirements
Returns
boolean
completedHomeActions
Get Signature
get completedHomeActions():
boolean
Defined in: bot/src/transformers/toggles/member.ts:128
Member has completed Server Guide new member actions
Returns
boolean
completedOnboarding
Get Signature
get completedOnboarding():
boolean
Defined in: bot/src/transformers/toggles/member.ts:113
Member has started onboarding
Returns
boolean
deaf
Get Signature
get deaf():
boolean
Defined in: bot/src/transformers/toggles/member.ts:83
Whether the user belongs to an OAuth2 application
Returns
boolean
didRejoin
Get Signature
get didRejoin():
boolean
Defined in: bot/src/transformers/toggles/member.ts:98
Member has left and rejoined the guild
Returns
boolean
dmSettingsUpsellAcknowledged
Get Signature
get dmSettingsUpsellAcknowledged():
boolean
Defined in: bot/src/transformers/toggles/member.ts:138
Member has dismissed the DM settings upsell
Returns
boolean
flags
Get Signature
get flags():
number
Defined in: bot/src/transformers/toggles/member.ts:65
Returns
number
isGuest
Get Signature
get isGuest():
boolean
Defined in: bot/src/transformers/toggles/member.ts:118
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: bot/src/transformers/toggles/member.ts:88
Whether the user is muted in voice channels
Returns
boolean
pending
Get Signature
get pending():
boolean
Defined in: bot/src/transformers/toggles/member.ts:93
Whether the user has not yet passed the guild's Membership Screening requirements
Returns
boolean
startedHomeActions
Get Signature
get startedHomeActions():
boolean
Defined in: bot/src/transformers/toggles/member.ts:123
Member has started Server Guide new member actions
Returns
boolean
startedOnboarding
Get Signature
get startedOnboarding():
boolean
Defined in: bot/src/transformers/toggles/member.ts:103
Member has completed onboarding
Returns
boolean
Methods
add()
add(
bits):this
Defined in: bot/src/transformers/toggles/ToggleBitfield.ts:14
Adds some bits to the bitfield.
Parameters
bits
number
Returns
this
Inherited from
contains()
contains(
bits):boolean
Defined in: bot/src/transformers/toggles/ToggleBitfield.ts:9
Tests whether or not this bitfield has the permission requested.
Parameters
bits
number
Returns
boolean
Inherited from
has()
has(
permissions):boolean
Defined in: bot/src/transformers/toggles/member.ts:148
Checks whether or not the permissions exist in this
Parameters
permissions
"deaf" | "mute" | "pending" | "didRejoin" | "startedOnboarding" | "bypassesVerification" | "completedOnboarding" | "isGuest" | "startedHomeActions" | "completedHomeActions" | "automodQuarantinedUsername" | "dmSettingsUpsellAcknowledged" | "automodQuarantinedGuildTag" | ("deaf" | "mute" | "pending" | "didRejoin" | "startedOnboarding" | "bypassesVerification" | "completedOnboarding" | "isGuest" | "startedHomeActions" | "completedHomeActions" | "automodQuarantinedUsername" | "dmSettingsUpsellAcknowledged" | "automodQuarantinedGuildTag")[]
Returns
boolean
list()
list():
Record<MemberToggleKeys,boolean>
Defined in: bot/src/transformers/toggles/member.ts:155
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: bot/src/transformers/toggles/ToggleBitfield.ts:20
Removes some bits from the bitfield.
Parameters
bits
number
Returns
this
Inherited from
toJSON()
toJSON():
number
Defined in: bot/src/transformers/toggles/ToggleBitfield.ts:25
Returns
number