Class

GuildMember

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

Extends Base

Constructor1 Properties16 Methods6 Source

Constructor

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

Param	Type	Description
client	`Client`
data	`APIGuildMember & { guild_id?: string }`
guild	`Guild`

Properties

accentColor: number | null

Guild-specific accent color (24-bit RGB).

avatar: string | null

Guild-specific avatar hash (null = use user avatar).

client: Client (readonly)

Parent client instance.

communicationDisabledUntil: Date | null

Timeout end date (null = not timed out).

deaf: boolean

Whether this member is voice-deafened.

displayName: string (readonly)

guild: Guild (readonly)

The guild this member belongs to.

id: string (readonly)

User ID (same as `user.id`).

joinedAt: Date (readonly)

When this member joined the guild.

mute: boolean

Whether this member is voice-muted.

nick: string | null

Guild-specific nickname (null = use global name or username).

permissions: PermissionsBitField (readonly)

Guild-level permissions (roles only, no channel overwrites).

profileFlags: number | null

Guild-specific profile flags.

roles: GuildMemberRoleManager (readonly)

Role manager for this member.

user: User (readonly)

The underlying User.

Methods

avatarURL(options?: { size?: number; extension?: string; }): string | null

Param	Type	Description
options?	`{ size?: number; extension?: string; }`

bannerURL(options?: { size?: number; extension?: string; }): string | null

Param	Type	Description
options?	`{ size?: number; extension?: string; }`

displayAvatarURL(options?: { size?: number; extension?: string; }): string

Param	Type	Description
options?	`{ size?: number; extension?: string; }`

edit(options: GuildMemberEditOptions): Promise<this>

PATCH member (`/members/@me` when editing the bot).

Param	Type	Description
options	`GuildMemberEditOptions`

move(channelId: string | null, connectionId?: string | null): Promise<void>

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

Param	Type	Description
channelId	`string \| null`	Voice channel ID or null to disconnect
connectionId?	`string \| null`	Optional connection ID for multi-session scenarios

permissionsIn(channel: GuildChannel): PermissionsBitField

Effective permissions in a channel (roles + overwrites).

Param	Type	Description
channel	`GuildChannel`	The guild channel