Class BannedMember

constructor

• new BannedMember(
      guildID: string,
      data: {
          createdAt: string;
          createdBy: string;
          reason?: string;
          user: {
              avatar?: string;
              id: string;
              name: string;
              type?: UserSummaryType;
          };
      },
      client: Client,
  ): BannedMember

  Parameters

  • guildID: string

    ID of the guild.
  • data: {
        createdAt: string;
        createdBy: string;
        reason?: string;
        user: { avatar?: string; id: string; name: string; type?: UserSummaryType };
    }

    raw data.

    • createdAt: string

      Created at Format: date-time

      Description

      The ISO 8601 timestamp that the server member ban was created at

    • createdBy: string

      Created by

      Description

      The ID of the user who created this server member ban

    • Optionalreason?: string

      Reason

      Description

      The reason for the ban as submitted by the banner

    • user: { avatar?: string; id: string; name: string; type?: UserSummaryType }

      • Optionalavatar?: string

        Avatar Format: media-uri

        Description

        The avatar image associated with the user

      • id: string

        User ID Format: user-id

        Description

        The ID of the user

      • name: string

        User name

        Description

        The user's name

      • Optionaltype?: UserSummaryType

        User type

        Description

        The type of user. If this property is absent, it can assumed to be of type user

  • client: Client

    client.

  Returns BannedMember

ban

guildID

member

user

guild

• get guild(): Guild | Promise<Guild>

  Getter used to get the message's guild

  Note: this can return a promise, make sure to await it before.

  Returns Guild | Promise<Guild>

toJSON

• toJSON(): JSONBannedMember

  Returns JSONBannedMember