Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GuildMember

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

client

client: Client

The client that instantiated this structure

data

data: APIGuildMember

Raw member data

guildId

guildId: string

Theof the Guild the member is in

Accessors

communicationDisabledUntil

  • get communicationDisabledUntil(): undefined | Date

  • The time this member's timeout will be removed

    Returns undefined | Date

communicationDisabledUntilTimestamp

  • get communicationDisabledUntilTimestamp(): undefined | number

  • The timestamp this member's timeout will be removed

    Returns undefined | number

guild

  • get guild(): undefined | Guild

  • The Guild object the member is in

    Returns undefined | Guild

id

  • get id(): string

  • Theof the member

    Returns string

joinedAt

  • get joinedAt(): Date

  • The time this member joined the guild

    Returns Date

joinedTimestamp

  • get joinedTimestamp(): number

  • The timestamp the member joined the guild at

    Returns number

nick

  • get nick(): null | string

  • The nick of the member

    Returns null | string

permissions

  • The overall set of permissions for this member, taking only roles and owner status into account

    Returns PermissionsBitField

premiumSince

  • get premiumSince(): null | Date

  • The last time this member started boosting the guild

    Returns null | Date

premiumSinceTimestamp

  • get premiumSinceTimestamp(): null | number

  • The last timestamp this member started boosting the guild

    Returns null | number

roles

  • The roles of the member

    example
    guildMember.roles.cache.map(r => r.name).join(', ');
    example
    guildMember.set([], 'They don\'t deserve roles');

    Returns GuildMemberRoleManager

user

  • The User object of the member

    Returns User

Methods

ban

  • ban(options?: BanOptions): undefined | Promise<GuildBan>

  • Bans this member from the guild

    example
    guildMember.ban()
    example
    guildMember.ban({ reason: 'Spamming', days: 1 })

    Parameters

    Returns undefined | Promise<GuildBan>

clone

  • clone(): any

  • Returns any

edit

  • Edits this member

    example
    guildMember.edit({ roles: ['12345678901234567'] })
    example
    guildMember.edit({ nick: 'Veric', roles: ['2345678954234590'] })

    Parameters

    • data: GuildMemberEditData

      The data to edit the member with

    • reason: string = ''

      The reason for editing the member

    Returns undefined | Promise<GuildMember>

fetch

  • Fetches this GuildMember

    Returns undefined | Promise<GuildMember>

kick

  • kick(reason?: string): undefined | Promise<undefined>

  • Kicks this member from the guild

    Parameters

    • reason: string = ''

      Reason for kicking user

    Returns undefined | Promise<undefined>

Private parseData

toString

  • toString(): string

  • Returns the mention of the member

    Returns string

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:15 AM