Class

GuildMember

Guild member — roles via member.roles, permissions via permissions / permissionsIn. Cached per guild in guild.members.

Extends Base

Constructor

new GuildMember(client: Client, data: APIGuildMember & { guild_id?: string }, guild: Guild)
client
Client
data
APIGuildMember & { guild_id?: string }
guild
Guild

Properties

NameTypeDescription
accentColornumber | nullGuild-specific accent color (24-bit RGB).
avatarstring | nullGuild-specific avatar hash (null = use user avatar).
clientread-onlyClientParent client instance.
communicationDisabledUntilDate | nullTimeout end date (null = not timed out).
deafbooleanWhether this member is voice-deafened.
displayNameread-onlystring
guildread-onlyGuildThe guild this member belongs to.
idread-onlystringUser ID (same as user.id).
joinedAtread-onlyDateWhen this member joined the guild.
mutebooleanWhether this member is voice-muted.
nickstring | nullGuild-specific nickname (null = use global name or username).
permissionsread-onlyPermissionsBitFieldGuild-level permissions (roles only, no channel overwrites).
profileFlagsnumber | nullGuild-specific profile flags.
rolesread-onlyGuildMemberRoleManagerRole manager for this member.
userread-onlyUserThe underlying User.

Methods

.avatarURL(options?)

options?: { size?: number; extension?: string; } → string | null

guild.members.me.avatarURL();

.bannerURL(options?)

options?: { size?: number; extension?: string; } → string | null

guild.members.me.bannerURL();

.move(channelId, connectionId?)

channelId: string | null, connectionId?: string | null → Promise<void>

Move to a voice channel, or null to disconnect. Requires Move Members.

channelId
string | nullVoice channel ID or null to disconnect
connectionId?
string | nullOptional connection ID for multi-session scenarios
await guild.members.me.move(channelId);

.toString()

→ string

Renders a mention for this member: <@id>.

guild.members.me.toString();