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: GuildMemberData, guild: Guild)
client
Client
data
GuildMemberData
guild
Guild

Properties

NameTypeDescription
accentColornumber | nullGuild-specific accent color (24-bit RGB).
avatarstring | nullGuild-specific avatar hash (null = use user avatar).
bannableread-onlybooleanWhether the bot can ban this member (cache-only; needs members.me).
biostring | nullGuild-specific bio (set from member edit; not always on GET member).
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.
kickableread-onlybooleanWhether the bot can kick this member (cache-only; needs members.me). False for the guild owner, self, or when the bot lacks Kick Members / role hierarchy.
mentionFlagsnumber | nullPer-guild reply mention preference override.
moderatableread-onlybooleanWhether the bot can timeout this member (cache-only; needs members.me).
mutebooleanWhether this member is voice-muted.
nickstring | nullGuild-specific nickname (null = use global name or username).
partialread-onlyfalseDiscriminant vs PartialGuildMember: always false on a hydrated member.
permissionsread-onlyPermissionsBitFieldGuild-level permissions (roles only, no channel overwrites).
profileFlagsnumber | nullGuild-specific profile flags.
pronounsstring | nullGuild-specific pronouns (set from member edit; not always on GET member).
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();

.kick()

Promise<void>

Kick this member. Requires Kick Members.

await guild.members.me.kick();

.move(channelId, connectionId?)

channelId: string | null, connectionId?: string | nullPromise<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);

.timeout(durationMs, reason?)

durationMs: number | null, reason?: stringPromise<this>

Timeout this member for durationMs milliseconds, or pass null to clear. Requires Moderate Members.

await guild.members.me.timeout(durationMs);

.toString()

string

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

guild.members.me.toString();