detritus
On this page

Guild Member Structure

import { Structures } from 'detritus-client';

Structures.Member;
57 properties21 methods65 inheritedsrc/structures/member.ts:74

Constructor

Properties

_avatar
string | null
Default null
_avatarDecorationData
Default null
_banner
string | null
Default null
_collectibles
Default null
_displayNameStyles
Default null
_hoistedRoleId?
string | null
optional
_permissions?
bigint
optional
Default 0n
_roles?
string[]
optional
client
readonly
Inherited from UserMixin.client
communicationDisabledUntilUnix
number
Default 0
deaf
boolean
Default false
flags
number
Default 0
guildId
string
Default ''
isPending
boolean
Default false
joinedAtUnix
number
Default 0
left
boolean
Default false
mute
boolean
Default false
nick
string | null
Default null
pending
boolean
Default false
premiumSinceUnix
number
Default 0
user
Overrides UserMixin.user

Accessors

avatar
string | null
get
avatarDecorationData
avatarUrl
string
get
Inherited from UserMixin.avatarUrl
bot
boolean
get
Inherited from UserMixin.bot
canAdministrator
boolean
get
canBanMembers
boolean
get
canChangeNickname
boolean
get
canChangeNicknames
boolean
get
canCreateInstantInvite
boolean
get
canKickMembers
boolean
get
canManageChannels
boolean
get
canManageEmojis
boolean
get
canManageGuild
boolean
get
canManageMessages
boolean
get
canManageRoles
boolean
get
canManageThreads
boolean
get
canManageWebhooks
boolean
get
canRequestToSpeak
boolean
get
canUseApplicationCommands
boolean
get
canUsePrivateThreads
boolean
get
canUsePublicThreads
boolean
get
canViewAuditLogs
boolean
get
clan
UserClan | null
get
Inherited from UserMixin.clan
collectibles
color
number
get
colorRole
Role | null
get
communicationDisabledUntil
Date | null
get
createdAt
Date
get
Inherited from UserMixin.createdAt
createdAtUnix
number
get
defaultAvatarUrl
string
get
discriminator
string
get
displayNameStyles
dm
Channel | null
get
Inherited from UserMixin.dm
globalName
string | null
get
Inherited from UserMixin.globalName
guild
Guild | null
get
guilds
get
Inherited from UserMixin.guilds
hasBugHunterLevel1
boolean
get
hasBugHunterLevel2
boolean
get
hasDiscordCertifiedModerator
boolean
get
hasEarlySupporter
boolean
get
hasFreePremium
boolean
get
hasGuildAvatar
boolean
get
hasGuildAvatarDecoration
boolean
get
hasHypesquad
boolean
get
Inherited from UserMixin.hasHypesquad
hasHypesquadHouseBalance
boolean
get
hasHypesquadHouseBravery
boolean
get
hasHypesquadHouseBrilliance
boolean
get
hasMfaSms
boolean
get
Inherited from UserMixin.hasMfaSms
hasPartner
boolean
get
Inherited from UserMixin.hasPartner
hasPremiumPromoDismissed
boolean
get
hasStaff
boolean
get
Inherited from UserMixin.hasStaff
hasTeamUser
boolean
get
Inherited from UserMixin.hasTeamUser
hasVerifiedBot
boolean
get
hasVerifiedDeveloper
boolean
get
highestRole
Role | null
get
hoistedRole
Role | null
get
hoistedRoleId
string | null
get · set

The highest role that's displayed separately in the member list worked out from the guild's current roles when read (discord only sends hoisted_role to user accounts) so it doesn't go stale when roles get moved or edited, and merging stays cheap

id
string
get
Inherited from UserMixin.id
isBoosting
boolean
get
isClientOwner
boolean
get
isClone
boolean
get
Inherited from UserMixin.isClone
isMe
boolean
get
Inherited from UserMixin.isMe
isOffline
boolean
get
isOwner
boolean
get
isPartial
boolean
get
isSystem
boolean
get
Inherited from UserMixin.isSystem
isWebhook
boolean
get
Inherited from UserMixin.isWebhook
joinedAt
Date | null
get
mention
string
get
messages
get
Inherited from UserMixin.messages
name
string
get
Overrides UserMixin.name
names
string[]
get
Overrides UserMixin.names
permissions
bigint
get
premiumSince
Date | null
get
presence
Presence | null
get
Inherited from UserMixin.presence
primaryGuild
UserClan | null
get
Inherited from UserMixin.primaryGuild
publicFlags
number
get
Inherited from UserMixin.publicFlags
roles
BaseCollection<string, Role | null>
get
shardId
number
get
Inherited from UserMixin.shardId
system
boolean | undefined
get
Inherited from UserMixin.system
tag
string
get
Inherited from UserMixin.tag
username
string
get
Inherited from UserMixin.username
voiceChannel
voiceState
VoiceState | null
get

Methods

can()

src/structures/member.ts:442
can(
  permissions: PermissionChecks,
  options?: { ignoreAdministrator?: boolean; ignoreOwner?: boolean },
): boolean
permissions
options?
{ ignoreAdministrator?: boolean; ignoreOwner?: boolean }
options.ignoreAdministrator?
boolean
options.ignoreOwner?
boolean