Class GuildBan

constructor

• new GuildBan(
      client: UsingClient,
      data: APIBan | ActuallyBan,
      guildId: string,
  ): GuildBan

  Parameters

  • client: UsingClient
  • data: APIBan | ActuallyBan
  • guildId: string

  Returns GuildBan

ReadonlyguildId

create

• create(body?: RESTPutAPIGuildBanJSONBody, reason?: string): Promise<void>

  Parameters

  • Optionalbody: RESTPutAPIGuildBanJSONBody
  • Optionalreason: string

  Returns Promise<void>

fetch

• fetch(force?: boolean): Promise<GuildBan>

  Parameters

  • force: boolean = false

  Returns Promise<GuildBan>

guild

• guild(mode?: "rest" | "flow"): Promise<Guild<"cached" | "api">>

  Parameters

  • Optionalmode: "rest" | "flow"

  Returns Promise<Guild<"cached" | "api">>

• guild(mode: "cache"): ReturnCache<undefined | Guild<"cached">>

  Parameters

  • mode: "cache"

  Returns ReturnCache<undefined | Guild<"cached">>

remove

• remove(reason?: string): Promise<undefined>

  Parameters

  • Optionalreason: string

  Returns Promise<undefined>

toString

• toString(): `<@${string}>`

  Returns a string representation of an object.

  Returns `<@${string}>`

Staticmethods

• methods(
      __namedParameters: { client: UsingClient; guildId: string },
  ): {
      bulkCreate: (
          body: RESTPostAPIGuildBulkBanJSONBody,
          reason?: string,
      ) => Promise<RESTPostAPIGuildBulkBanResult>;
      create: (
          memberId: string,
          body?: RESTPutAPIGuildBanJSONBody,
          reason?: string,
      ) => Promise<void>;
      fetch: (userId: string, force?: boolean) => Promise<GuildBan>;
      list: (
          query?: RESTGetAPIGuildBansQuery,
          force?: boolean,
      ) => Promise<GuildBan[]>;
      remove: (memberId: string, reason?: string) => Promise<undefined>;
  }

  Parameters

  • __namedParameters: { client: UsingClient; guildId: string }

  Returns {
      bulkCreate: (
          body: RESTPostAPIGuildBulkBanJSONBody,
          reason?: string,
      ) => Promise<RESTPostAPIGuildBulkBanResult>;
      create: (
          memberId: string,
          body?: RESTPutAPIGuildBanJSONBody,
          reason?: string,
      ) => Promise<void>;
      fetch: (userId: string, force?: boolean) => Promise<GuildBan>;
      list: (
          query?: RESTGetAPIGuildBansQuery,
          force?: boolean,
      ) => Promise<GuildBan[]>;
      remove: (memberId: string, reason?: string) => Promise<undefined>;
  }