Class ServerBan

constructor

• new ServerBan(client, data, user?): ServerBan

• Construct Server Ban

  Parameters

  • client: Client

    Client

  • data: {
        _id: {
            server: string;
            user: string;
        };
        reason?: null | string;
    }

    Data

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

      Description

      Unique member id

      • server: string

        Description

        Server Id

      • user: string

        Description

        User Id

    • Optional reason?: null | string

      Description

      Reason for ban creation

  • Optional user: {
        _id: 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;
        };
        discriminator: string;
        username: string;
    }

    • _id: string

      Description

      Id of the banned user

    • Optional 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;
      }

      Description

      Avatar of the banned user

    • discriminator: string

      Description

      Discriminator of the banned user

    • username: string

      Description

      Username of the banned user

  Returns ServerBan

Readonly id

Optional Readonly reason

Optional Readonly user

server

• get server(): undefined | Server

• Server

  Returns undefined | Server

pardon

• pardon(): Promise<void>

• Remove this server ban

  Returns Promise<void>