Class AutoModerationRule

constructor

• new AutoModerationRule(
      client: UsingClient,
      data: APIAutoModerationRule,
  ): AutoModerationRule

  Parameters

  • client: UsingClient
  • data: APIAutoModerationRule

  Returns AutoModerationRule

Readonlyclient

createdAt

• get createdAt(): Date

  createdAt gets the creation Date instace of the current object.

  Returns Date

createdTimestamp

• get createdTimestamp(): number

  Create a timestamp for the current object.

  Returns number

delete

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

  Parameters

  • Optionalreason: string

  Returns Promise<undefined>

edit

• edit(
      body: RESTPatchAPIAutoModerationRuleJSONBody,
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • body: RESTPatchAPIAutoModerationRuleJSONBody
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

fetch

• fetch(): Promise<AutoModerationRule>

  Returns Promise<AutoModerationRule>

fetchCreator

• fetchCreator(force?: boolean): Promise<GuildMember>

  Parameters

  • force: boolean = false

  Returns Promise<GuildMember>

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">>

Staticmethods

• methods(
      __namedParameters: { client: UsingClient; guildId: string },
  ): {
      create: (
          body: RESTPostAPIAutoModerationRuleJSONBody,
      ) => Promise<AutoModerationRule>;
      delete: (ruleId: string, reason?: string) => Promise<undefined>;
      edit: (
          ruleId: string,
          body: RESTPatchAPIAutoModerationRuleJSONBody,
          reason?: string,
      ) => Promise<AutoModerationRule>;
      fetch: (ruleId: string) => Promise<AutoModerationRule>;
      list: () => Promise<AutoModerationRule[]>;
  }

  Parameters

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

  Returns {
      create: (
          body: RESTPostAPIAutoModerationRuleJSONBody,
      ) => Promise<AutoModerationRule>;
      delete: (ruleId: string, reason?: string) => Promise<undefined>;
      edit: (
          ruleId: string,
          body: RESTPatchAPIAutoModerationRuleJSONBody,
          reason?: string,
      ) => Promise<AutoModerationRule>;
      fetch: (ruleId: string) => Promise<AutoModerationRule>;
      list: () => Promise<AutoModerationRule[]>;
  }