Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GuildMember<T>

Type parameters

  • T

Hierarchy

Index

Constructors

constructor

Properties

Readonly client

client: T

deaf

deaf: boolean | null

Whether or not the user is deafened in voice channels.

since

0.0.1

deleted

deleted: boolean = false

Whether the member was kicked.

since

0.0.1

Readonly guild

guild: Guild

The Guild this member belongs to.

since

0.0.1

Readonly id

id: string

The member's ID.

since

0.0.1

joinedTimestamp

joinedTimestamp: number | null

When the user joined the guild.

since

0.0.1

mute

mute: boolean | null

Whether or not the user is muted in voice channels.

since

0.0.1

nick

nick: string | null

This user's guild nickname.

since

0.0.1

premiumSince

premiumSince: number | null

When the user started boosting the guild.

since

0.0.1

see

https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-

roles

The roles this member has.

since

0.0.1

Accessors

Protected _manageable

  • get _manageable(): boolean | null
  • Whether or not the client user can manage this member. This is based on:

    • The member is not the {@link Guild#owner guild owner}.
    • The client user is the owner of the Guild.
    • The client user's {@link GuildMemberRoleStore#highest highest role} is higher than the member's.
    since

    0.0.1

    Returns boolean | null

    true when any of the conditions are met, null when the client user's member is not cached (or when {@link Client#user} is null), or false otherwise.

bannable

  • get bannable(): boolean | null

createdAt

  • get createdAt(): Date

createdTimestamp

  • get createdTimestamp(): number

displayName

  • get displayName(): string | null

kickable

  • get kickable(): boolean | null

manageNicknames

  • get manageNicknames(): boolean | null

manageRoles

  • get manageRoles(): boolean | null

permissions

user

  • get user(): User | null

voiceState

Methods

Protected _patch

clone

  • clone(): this

kick

  • kick(requestOptions?: RequestOptions): Promise<this>

modify

permissionsIn

toJSON

  • toJSON(): Record<string, any>

toString

  • toString(): string

valueOf

  • valueOf(): string

Generated using TypeDoc