GuildMember

Extends

• Base

Type Parameters

Constructors

new GuildMember()

new GuildMember<IsPartial, IsGuildPartial>(client, rawData, guild): GuildMember<IsPartial, IsGuildPartial>

Parameters

Returns

GuildMember<IsPartial, IsGuildPartial>

Overrides

Base.constructor

Properties

Accessors

avatar

get avatar(): IfPartial<IsPartial, null | string>

The guild-specific avatar hash of the member. You can use GuildMember.avatarUrl to get the URL of the avatar.

Returns

IfPartial<IsPartial, null | string>

---

avatarUrl

get avatarUrl(): IfPartial<IsPartial, null | string>

Get the URL of the member's guild-specific avatar

Returns

IfPartial<IsPartial, null | string>

---

communicationDisabledUntil

get communicationDisabledUntil(): IfPartial<IsPartial, null | string>

The date when the member's communication privileges (timeout) will be reinstated

Returns

IfPartial<IsPartial, null | string>

---

deaf

get deaf(): IfPartial<IsPartial, boolean>

Is this member deafened in Voice Channels?

Returns

IfPartial<IsPartial, boolean>

---

flags

get flags(): IfPartial<IsPartial, GuildMemberFlags>

The flags of the member.

See

https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-flags

Returns

IfPartial<IsPartial, GuildMemberFlags>

---

joinedAt

get joinedAt(): IfPartial<IsPartial, string>

The joined date of the member

Returns

IfPartial<IsPartial, string>

---

mute

get mute(): IfPartial<IsPartial, boolean>

Is this member muted in Voice Channels?

Returns

IfPartial<IsPartial, boolean>

---

nickname

get nickname(): IfPartial<IsPartial, null | string>

The guild-specific nickname of the member.

Returns

IfPartial<IsPartial, null | string>

---

pending

get pending(): IfPartial<IsPartial, boolean>

Is this member yet to pass the guild's Membership Screening requirements?

Returns

IfPartial<IsPartial, boolean>

---

premiumSince

get premiumSince(): IfPartial<IsPartial, null | string>

The date since this member boosted the guild, if applicable.

Returns

IfPartial<IsPartial, null | string>

---

roles

get roles(): IfPartial<IsPartial, Role<true>[]>

The roles of the member

Returns

IfPartial<IsPartial, Role<true>[]>

Methods

addRole()

addRole(roleId): Promise<void>

Add a role to the member

Parameters

Returns

Promise<void>

---

ban()

ban(options): Promise<void>

Ban the member from the guild

Parameters

Returns

Promise<void>

---

deafenMember()

deafenMember(): Promise<void>

Deafen a member in voice channels

Returns

Promise<void>

---

kick()

kick(): Promise<void>

Kick the member from the guild

Returns

Promise<void>

---

muteMember()

muteMember(): Promise<void>

Mute a member in voice channels

Returns

Promise<void>

---

removeRole()

removeRole(roleId): Promise<void>

Remove a role from the member

Parameters

Returns

Promise<void>

---

setNickname()

setNickname(nickname): Promise<void>

Set the nickname of the member

Parameters

Returns

Promise<void>

---

timeoutMember()

timeoutMember(communicationDisabledUntil): Promise<void>

Set or remove a timeout for a member in the guild

Parameters

Returns

Promise<void>

---

undeafenMember()

undeafenMember(): Promise<void>

Undeafen a member in voice channels

Returns

Promise<void>

---

unmuteMember()

unmuteMember(): Promise<void>

Unmute a member in voice channels

Returns

Promise<void>