Class Member

Represents a member of a guild.

Hierarchy

Constructors

constructor

Properties

avatar client communicationDisabledUntil deaf flags guildID id isPending? joinedAt mute nick pending premiumSince presence? roles user

Accessors

bot createdAt discriminator displayName guild mention permissions publicFlags system tag username voiceState

Methods

addRole avatarURL ban disableVerificationBypass edit editVoiceState enableVerificationBypass kick removeRole toJSON toString unban getCreatedAt getDiscordEpoch

Constructors

constructor

Properties

avatar

avatar: null | string

The member's avatar hash, if they have set a guild avatar.

client

client: Client<ClientEvents>

communicationDisabledUntil

communicationDisabledUntil: null | Date

When the member's timeout will expire, if active.

deaf

deaf: boolean

If this member is server deafened.

flags

flags: number

The member's flags.

guildID

guildID: string

The id of the guild this member is for.

id

id: string

Optional isPending

isPending?: boolean

Undocumented.

joinedAt

joinedAt: null | Date

The date at which this member joined the guild.

mute

mute: boolean

If this member is server muted.

nick

nick: null | string

This member's nickname, if any.

pending

pending: boolean

If this member has not passed the guild's membership screening requirements.

premiumSince

premiumSince: null | Date

The date at which this member started boosting the guild, if applicable.

Optional presence

presence?: Presence

The presence of this member.

roles

roles: string[]

The roles this member has.

user

user: User

The user associated with this member.

Accessors

bot

createdAt

discriminator

  • get discriminator(): string

  • The 4 digits after the username of the user associated with this member.

    Returns string

displayName

  • get displayName(): string

  • The nick of this member if set, or the username of this member's user.

    Returns string

guild

mention

permissions

publicFlags

system

  • get system(): boolean

  • If this user associated with this member is an official discord system user.

    Returns boolean

tag

  • get tag(): string

  • A combination of the user associated with this member's username and discriminator.

    Returns string

username

voiceState

Methods

addRole

  • Add a role to this member.

    Parameters

    • roleID: string

      The ID of the role to add.

    • Optional reason: string

    Returns Promise<void>

avatarURL

  • The url of this user's guild avatar (or their user avatar if no guild avatar is set, or their default avatar if none apply).

    Parameters

    • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

      The format the url should be.

    • Optional size: number

      The dimensions of the image.

    Returns string

ban

disableVerificationBypass

  • Disable the BYPASSES_VERIFICATION flag for this member. Requires the Manage Guild permission.

    Returns Promise<void>

edit

editVoiceState

enableVerificationBypass

  • Enable the BYPASSES_VERIFICATION flag for this member. Requires the Manage Guild permission.

    Returns Promise<void>

kick

  • Remove a member from the guild.

    Parameters

    • Optional reason: string

      The reason for the kick.

    Returns Promise<void>

removeRole

  • remove a role from this member.

    Parameters

    • roleID: string

      The ID of the role to remove.

    • Optional reason: string

      The reason for removing the role.

    Returns Promise<void>

toJSON

toString

unban

  • Remove a ban for this member.

    Parameters

    • Optional reason: string

      The reason for removing the ban.

    Returns Promise<void>

Static getCreatedAt

Static getDiscordEpoch

Settings

Member Visibility

Theme