Class Member

constructor

• new Member(client, data): Member

• Parameters

  • client: Client

  • data: UpgradedServerMemberPayload

  Returns Member

_joinedAt

banned

isOwner

kicked

nickname

roleIds

Readonly serverId

socialLinks

displayName

• get displayName(): null | string

• Either the nickname or the username associated with this member.

  Returns null | string

  The nickname of this member or their username if they have no nickname, or null if the user does not exist.

joinedAt

• get joinedAt(): null | Date

• Returns null | Date

user

• get user(): null | User

• Get the user associated with this member.

  Returns null | User

  The user associated with this member or null if the user is not cached.

username

• get username(): null | string

• The username of this member.

  Returns null | string

  The username of this member or null if the user is not cached.

_update

• _update(data): Member

• Parameters

  • data: Partial<ServerMemberPayload & {
        banned: boolean;
        kicked: boolean;
    }>

  Returns Member

addRole

• addRole(roleId): Promise<void>

• Add role to this member.

  Parameters

  • roleId: number

    The ID of the role to add to the member.

  Returns Promise<void>

  A Promise that resolves once the role has been added to the member.

awardXP

• awardXP(amount): Promise<number>

• Award XP to this member.

  Parameters

  • amount: number

    The amount of XP to award to the member.

  Returns Promise<number>

  A Promise that resolves with the new total amount of XP the member has.

ban

• ban(): Promise<MemberBan>

• Ban this user

  Returns Promise<MemberBan>

  A Promise that resolved to the created member ban.

getRoles

• getRoles(): Promise<number[]>

• Get a list of the roles assigned to this member.

  Returns Promise<number[]>

  A Promise that resolves with an array of role IDs assigned to this member.

kick

• kick(): Promise<null | Member>

• Kick this user from the server.

  Returns Promise<null | Member>

  A Promise that resolves with the kicked member or null if the user is not a member of the server.

removeRole

• removeRole(roleId): Promise<void>

• Remove role from this member.

  Parameters

  • roleId: number

    The ID of the role to remove from the member.

  Returns Promise<void>

  A Promise that resolves once the role has been removed from the member.

resetNickname

• resetNickname(): Promise<void>

• Reset this member's nickname.

  Returns Promise<void>

  A Promise that resolves once the member's nickname has been reset.

updateNickname

• updateNickname(nickname): Promise<string>

• Update this member's nickname.

  Parameters

  • nickname: string

    The new nickname for the member.

  Returns Promise<string>

  A Promise that resolves with the new nickname for the member.