Class Member

constructor

• new Member(data, client, guildID): Member

• Parameters

  • data: Object

  • client: Client<ClientEvents>

  • guildID: string

  Returns Member

avatar

communicationDisabledUntil

deaf

flags

guildID

Optional isPending

joinedAt

mute

nick

pending

premiumSince

Optional presence

roles

user

bot

• get bot(): boolean

• If the member associated with the user is a bot.

  Returns boolean

discriminator

• get discriminator(): string

• The Discord-tag of the user associated with this member.

  Returns string

displayName

• get displayName(): string

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

  Returns string

guild

• get guild(): Guild

• The guild this member is for. This will throw an error if the guild is not cached.

  Returns Guild

mention

• get mention(): string

• A string that will mention this member.

  Returns string

permissions

• get permissions(): Permission

• The permissions of this member.

  Returns Permission

publicFlags

• get publicFlags(): number

• The user associated with this member's public flags.

  Returns number

system

• get system(): boolean

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

  Returns boolean

tag

• get tag(): string

• The 4 digits after this user's username, if they have not been migrated. If migrated, this will be a single "0".

  Returns string

username

• get username(): string

• The username associated with this member's user.

  Returns string

voiceState

• get voiceState(): null | VoiceState<AnyVoiceChannel>

• The voice state of this member.

  Returns null | VoiceState<AnyVoiceChannel>

addRole

• addRole(roleID, reason?): Promise<void>

• Add a role to this member.

  Parameters

  • roleID: string

    The ID of the role to add.

  • Optional reason: string

  Returns Promise<void>

avatarURL

• avatarURL(format?, size?): string

• 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

• ban(options?): Promise<void>

• Create a ban for this member.

  Parameters

  • Optional options: CreateBanOptions

    The options for the ban.

  Returns Promise<void>

disableVerificationBypass

• disableVerificationBypass(): Promise<void>

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

  Returns Promise<void>

edit

• edit(options): Promise<Member>

• Edit this member. Use ~Guild#editCurrentMember | Guild#editCurrentMember if you wish to update the nick of this client using the CHANGE_NICKNAME permission.

  Parameters

  • options: EditMemberOptions

    The options for editing the member.

  Returns Promise<Member>

editVoiceState

• editVoiceState(options): Promise<void>

• Edit this guild member's voice state. channelID is required, and the user must already be in that channel. See Discord's docs for more information.

  Parameters

  • options: EditUserVoiceStateOptions

    The options for editing the voice state.

  Returns Promise<void>

enableVerificationBypass

• enableVerificationBypass(): Promise<void>

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

  Returns Promise<void>

kick

• kick(reason?): Promise<void>

• Remove a member from the guild.

  Parameters

  • Optional reason: string

    The reason for the kick.

  Returns Promise<void>

removeRole

• removeRole(roleID, reason?): Promise<void>

• 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

• toJSON(): JSONMember

• Returns JSONMember

unban

• unban(reason?): Promise<void>

• Remove a ban for this member.

  Parameters

  • Optional reason: string

    The reason for removing the ban.

  Returns Promise<void>