MemberToggles
@discordeno/bot • Docs
Documentation / @discordeno/bot / MemberToggles
Class: MemberToggles
Extends
Constructors
new MemberToggles()
new MemberToggles(
memberOrTogglesInt):MemberToggles
Parameters
• memberOrTogglesInt: number | Partial<DiscordMember>
Returns
Overrides
Defined in
packages/bot/src/transformers/toggles/member.ts:37
Properties
bitfield
bitfield:
number=0
Inherited from
Defined in
packages/bot/src/transformers/toggles/ToggleBitfield.ts:2
Accessors
automodQuarantinedUsername
Get Signature
get automodQuarantinedUsername():
boolean
Member's username, display name, or nickname is blocked by AutoMod
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:129
bypassesVerification
Get Signature
get bypassesVerification():
boolean
Member is exempt from guild verification requirements
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:104
completedHomeActions
Get Signature
get completedHomeActions():
boolean
Member has completed Server Guide new member actions
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:124
completedOnboarding
Get Signature
get completedOnboarding():
boolean
Member has started onboarding
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:109
deaf
Get Signature
get deaf():
boolean
Whether the user belongs to an OAuth2 application
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:79
didRejoin
Get Signature
get didRejoin():
boolean
Member has left and rejoined the guild
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:94
dmSettingsUpsellAcknowledged
Get Signature
get dmSettingsUpsellAcknowledged():
boolean
Member has dismissed the DM settings upsell
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:134
flags
Get Signature
get flags():
number
Returns
number
Defined in
packages/bot/src/transformers/toggles/member.ts:62
isGuest
Get Signature
get isGuest():
boolean
Member is a guest and can only access the voice channel they were invited to
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:114
mute
Get Signature
get mute():
boolean
Whether the user is muted in voice channels
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:84
pending
Get Signature
get pending():
boolean
Whether the user has not yet passed the guild's Membership Screening requirements
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:89
startedHomeActions
Get Signature
get startedHomeActions():
boolean
Member has started Server Guide new member actions
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:119
startedOnboarding
Get Signature
get startedOnboarding():
boolean
Member has completed onboarding
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:99
Methods
add()
add(
bits):this
Adds some bits to the bitfield.
Parameters
• bits: number
Returns
this
Inherited from
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
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: "deaf" | "mute" | "pending" | "didRejoin" | "startedOnboarding" | "bypassesVerification" | "completedOnboarding" | "isGuest" | "startedHomeActions" | "completedHomeActions" | "automodQuarantinedUsername" | "dmSettingsUpsellAcknowledged" | ("deaf" | "mute" | "pending" | "didRejoin" | "startedOnboarding" | "bypassesVerification" | "completedOnboarding" | "isGuest" | "startedHomeActions" | "completedHomeActions" | "automodQuarantinedUsername" | "dmSettingsUpsellAcknowledged")[]
Returns
boolean
Defined in
packages/bot/src/transformers/toggles/member.ts:139
list()
list():
Record<"deaf"|"mute"|"pending"|"didRejoin"|"startedOnboarding"|"bypassesVerification"|"completedOnboarding"|"isGuest"|"startedHomeActions"|"completedHomeActions"|"automodQuarantinedUsername"|"dmSettingsUpsellAcknowledged",boolean>
Lists all the toggles for the role and whether or not each is true or false.
Returns
Record<"deaf" | "mute" | "pending" | "didRejoin" | "startedOnboarding" | "bypassesVerification" | "completedOnboarding" | "isGuest" | "startedHomeActions" | "completedHomeActions" | "automodQuarantinedUsername" | "dmSettingsUpsellAcknowledged", boolean>
Defined in
packages/bot/src/transformers/toggles/member.ts:146
remove()
remove(
bits):this
Removes some bits from the bitfield.
Parameters
• bits: number
Returns
this
Inherited from
Defined in
packages/bot/src/transformers/toggles/ToggleBitfield.ts:20
toJSON()
toJSON():
number
Returns
number