Class ServerMember

constructor

• new ServerMember(
      client: client,
      data: {
          _id: { server: string; user: string };
          avatar?:
              | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
          joined_at: string;
          nickname?: null
          | string;
          roles?: string[];
          timeout?: null | string;
      },
  ): ServerMember

  Creates a new ServerMember instance.

  Parameters

  • client: client

    The client instance.
  • data: {
        _id: { server: string; user: string };
        avatar?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        joined_at: string;
        nickname?: null
        | string;
        roles?: string[];
        timeout?: null | string;
    }

    The raw data for the server member from the API.

    • _id: { server: string; user: string }

      Description

      Unique member id

      • server: string

        Description

        Server Id

      • user: string

        Description

        User Id

    • Optionalavatar?:
          | null
          | {
              _id: string;
              content_type: string;
              deleted?: null
              | boolean;
              filename: string;
              message_id?: null | string;
              metadata:
                  | { type: "File" }
                  | { type: "Text" }
                  | { height: number; type: "Image"; width: number }
                  | { height: number; type: "Video"; width: number }
                  | { type: "Audio" };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          }

      Description

      Avatar attachment

    • joined_at: string

      Description

      Time at which this user joined the server

    • Optionalnickname?: null | string

      Description

      Member's nickname

    • Optionalroles?: string[]

      Description

      Member's roles

    • Optionaltimeout?: null | string

      Description

      Timestamp this member is timed out until

  Returns ServerMember

avatar

nickname

roles

serverId

server

• get server(): Server

  Retrieves the server this member belongs to.

  Returns Server

  The server instance.

user

• get user(): User

  Retrieves the user associated with this server member.

  Returns User

  The user instance.

addRole

• addRole(roleId: string): Promise<ServerMember>

  adds a role to the server member.

  Parameters

  • roleId: string

    The ID of the role to add to the member.

  Returns Promise<ServerMember>

ban

• ban(reason?: string): Promise<void>

  Bans the server member.

  Parameters

  • Optionalreason: string

    The reason for the ban.

  Returns Promise<void>

  A promise that resolves when the member is banned.

  Example

  await member.ban("Violation of rules");
  Copy

kick

• kick(): Promise<void>

  Kicks the server member.

  Returns Promise<void>

  A promise that resolves when the member is kicked.

  Example

  await member.kick();
  Copy

leave

• leave(): Promise<void>

  Leaves the server.

  Returns Promise<void>

  A promise that resolves when the member leaves the server.

  Example

  await member.leave();
  Copy

removeRole

• removeRole(roleId: string): Promise<ServerMember>

  Removes a role from the server member.

  Parameters

  • roleId: string

    The ID of the role to remove from the member.

  Returns Promise<ServerMember>

  A promise that resolves with the updated server member instance.

  Example

  await member.removeRole("roleId");
  Copy

setNickname

• setNickname(nickname?: string): Promise<ServerMember>

  Sets the nickname of the server member.

  Parameters

  • Optionalnickname: string

    The new nickname to set, or undefined to clear the nickname.

  Returns Promise<ServerMember>

  A promise that resolves with the updated server member instance.

  Example

  await member.setNickname("NewNickname");
  Copy

toString

• toString(): string

  Converts the server member to a string representation.

  Returns string

  A string representation of the server member in the format <@userId>.