Class ServerMember

constructor

• new ServerMember(
      collection: ServerMemberCollection,
      id: { server: string; user: string },
  ): ServerMember

  Construct Server Member

  Parameters

  • collection: ServerMemberCollection

    Collection
  • id: { server: string; user: string }

    Id

    • server: string

      Description

      Server Id

    • user: string

      Description

      User Id

  Returns ServerMember

Readonlyid

$exists

• get $exists(): boolean

  Whether this object exists

  Returns boolean

animatedAvatarURL

• get animatedAvatarURL(): undefined | string

  URL to the member's animated avatar

  Returns undefined | string

avatar

• get avatar(): undefined | File

  Avatar

  Returns undefined | File

avatarURL

• get avatarURL(): undefined | string

  URL to the member's avatar

  Returns undefined | string

displayName

• get displayName(): undefined | string

  Display name

  Returns undefined | string

hoistedRole

• get hoistedRole(): null | ServerRole

  Member's currently hoisted role.

  Returns null | ServerRole

iconRole

• get iconRole(): undefined | null | ServerRole

  Member's current role icon with name.

  Returns undefined | null | ServerRole

joinedAt

• get joinedAt(): Date

  When this user joined the server

  Returns Date

nickname

• get nickname(): undefined | string

  Nickname

  Returns undefined | string

orderedRoles

• get orderedRoles(): ServerRole[]

  Ordered list of roles for this member, from lowest to highest priority.

  Returns ServerRole[]

pronouns

• get pronouns(): undefined | string

  Pronouns

  Returns undefined | string

ranking

• get ranking(): number

  Member's ranking Smaller values are ranked as higher priority

  Returns number

roleColour

• get roleColour(): undefined | null | string

  Member's current role colour.

  Returns undefined | null | string

roles

• get roles(): string[]

  List of role IDs

  Returns string[]

server

• get server(): undefined | Server

  Server this member belongs to

  Returns undefined | Server

timeout

• get timeout(): undefined | Date

  Time at which timeout expires

  Returns undefined | Date

user

• get user(): undefined | User

  User corresponding to this member

  Returns undefined | User

ban

• ban(
      options: {
          delete_message_seconds?: null | number;
          reason?: null | string;
      },
  ): Promise<void>

  Ban this member from the server

  Parameters

  • options: { delete_message_seconds?: null | number; reason?: null | string }

    Ban options

    • Optionaldelete_message_seconds?: null | number

      Format: int64

      Description

      Messages to delete in seconds

    • Optionalreason?: null | string

      Description

      Ban reason

  Returns Promise<void>

edit

• edit(
      data: {
          avatar?: null | string;
          can_publish?: null | boolean;
          can_receive?: null | boolean;
          nickname?: null | string;
          pronouns?: null | string;
          remove?: (
              | "Avatar"
              | "Pronouns"
              | "Nickname"
              | "Roles"
              | "Timeout"
              | "CanReceive"
              | "CanPublish"
              | "JoinedAt"
              | "VoiceChannel"
          )[];
          roles?: null
          | string[];
          timeout?: null | string;
          voice_channel?: null | string;
      },
  ): Promise<void>

  Edit a member

  Parameters

  • data: {
        avatar?: null | string;
        can_publish?: null | boolean;
        can_receive?: null | boolean;
        nickname?: null | string;
        pronouns?: null | string;
        remove?: (
            | "Avatar"
            | "Pronouns"
            | "Nickname"
            | "Roles"
            | "Timeout"
            | "CanReceive"
            | "CanPublish"
            | "JoinedAt"
            | "VoiceChannel"
        )[];
        roles?: null
        | string[];
        timeout?: null | string;
        voice_channel?: null | string;
    }

    Changes

    • Optionalavatar?: null | string

      Description

      Attachment Id to set for avatar

    • Optionalcan_publish?: null | boolean

      Description

      server-wide voice muted

    • Optionalcan_receive?: null | boolean

      Description

      server-wide voice deafened

    • Optionalnickname?: null | string

      Description

      Member nickname

    • Optionalpronouns?: null | string

      Description

      Member pronouns

    • Optionalremove?: (
          | "Avatar"
          | "Pronouns"
          | "Nickname"
          | "Roles"
          | "Timeout"
          | "CanReceive"
          | "CanPublish"
          | "JoinedAt"
          | "VoiceChannel"
      )[]

      Description

      Fields to remove from channel object

      Default

      []
      Copy

    • Optionalroles?: null | string[]

      Description

      Array of role ids

    • Optionaltimeout?: null | string

      Description

      Timestamp this member is timed out until

    • Optionalvoice_channel?: null | string

      Description

      voice channel to move to if already in a voice channel

  Returns Promise<void>

getPermissions

• getPermissions(target: Channel | Server): bigint

  Get the permissions that this member has against a certain object

  Parameters

  • target: Channel | Server

    Target object to check permissions against

  Returns bigint

  Permissions that this member has

hasPermission

• hasPermission(
      target: Channel | Server,
      ...permission: (
          | "Video"
          | "Masquerade"
          | "ManageChannel"
          | "ManageServer"
          | "ManagePermissions"
          | "ManageRole"
          | "ManageCustomisation"
          | "KickMembers"
          | "BanMembers"
          | "TimeoutMembers"
          | "AssignRoles"
          | "ChangeNickname"
          | "ManageNicknames"
          | "ChangeAvatar"
          | "RemoveAvatars"
          | "ViewChannel"
          | "ReadMessageHistory"
          | "SendMessage"
          | "ManageMessages"
          | "ManageWebhooks"
          | "InviteOthers"
          | "SendEmbeds"
          | "UploadFiles"
          | "React"
          | "BypassSlowmode"
          | "Connect"
          | "Speak"
          | "MuteMembers"
          | "DeafenMembers"
          | "MoveMembers"
          | "Listen"
          | "MentionEveryone"
          | "MentionRoles"
          | "ViewAuditLogs"
          | "GrantAllSafe"
      )[],
  ): boolean

  Check whether a member has a certain permission against a certain object

  Parameters

  • target: Channel | Server

    Target object to check permissions against
  • ...permission: (
        | "Video"
        | "Masquerade"
        | "ManageChannel"
        | "ManageServer"
        | "ManagePermissions"
        | "ManageRole"
        | "ManageCustomisation"
        | "KickMembers"
        | "BanMembers"
        | "TimeoutMembers"
        | "AssignRoles"
        | "ChangeNickname"
        | "ManageNicknames"
        | "ChangeAvatar"
        | "RemoveAvatars"
        | "ViewChannel"
        | "ReadMessageHistory"
        | "SendMessage"
        | "ManageMessages"
        | "ManageWebhooks"
        | "InviteOthers"
        | "SendEmbeds"
        | "UploadFiles"
        | "React"
        | "BypassSlowmode"
        | "Connect"
        | "Speak"
        | "MuteMembers"
        | "DeafenMembers"
        | "MoveMembers"
        | "Listen"
        | "MentionEveryone"
        | "MentionRoles"
        | "ViewAuditLogs"
        | "GrantAllSafe"
    )[]

    Permission names to check for

  Returns boolean

  Whether the member has this permission

inferiorTo

• inferiorTo(target: ServerMember): boolean

  Checks whether the target member has a higher rank than this member.

  Parameters

  • target: ServerMember

    The member to compare against

  Returns boolean

  Whether this member is inferior to the target

kick

• kick(): Promise<void>

  Kick this member from the server

  Returns Promise<void>

removeTimeout

• removeTimeout(): Promise<void>

  Remove this member's timeout

  Returns Promise<void>

setTimeout

• setTimeout(date: string): Promise<void>

  Timeout this member until the given date

  Parameters

  • date: string

    ISO8601 timestamp to time out until

  Returns Promise<void>

toString

• toString(): string

  Convert to string

  Returns string

  String