Class AutoModerationRule

actions

creatorId

enabled

eventType

exemptChannels

exemptRoles

guild

id

name

triggerMetadata

triggerType

delete

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

  Parameters

  • Optionalreason: string

  Returns Promise<void>

edit

• edit(options: AutoModerationRuleEditOptions): Promise<AutoModerationRule>

  Parameters

  • options: AutoModerationRuleEditOptions

  Returns Promise<AutoModerationRule>

setActions

• setActions(
      actions: readonly AutoModerationActionOptions[],
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • actions: readonly AutoModerationActionOptions[]
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setAllowList

• setAllowList(
      allowList: readonly string[],
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • allowList: readonly string[]
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setEnabled

• setEnabled(enabled?: boolean, reason?: string): Promise<AutoModerationRule>

  Parameters

  • Optionalenabled: boolean
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setEventType

• setEventType(
      eventType: AutoModerationRuleEventType,
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • eventType: AutoModerationRuleEventType
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setExemptChannels

• setExemptChannels(
      channels:
          | ReadonlyCollection<string, GuildBasedChannel>
          | readonly GuildChannelResolvable[],
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • channels:
        | ReadonlyCollection<string, GuildBasedChannel>
        | readonly GuildChannelResolvable[]
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setExemptRoles

• setExemptRoles(
      roles: ReadonlyCollection<string, Role> | readonly RoleResolvable[],
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • roles: ReadonlyCollection<string, Role> | readonly RoleResolvable[]
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setKeywordFilter

• setKeywordFilter(
      keywordFilter: readonly string[],
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • keywordFilter: readonly string[]
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setMentionRaidProtectionEnabled

• setMentionRaidProtectionEnabled(
      mentionRaidProtectionEnabled: boolean,
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • mentionRaidProtectionEnabled: boolean
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setMentionTotalLimit

• setMentionTotalLimit(
      mentionTotalLimit: number,
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • mentionTotalLimit: number
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setName

• setName(name: string, reason?: string): Promise<AutoModerationRule>

  Parameters

  • name: string
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setPresets

• setPresets(
      presets: readonly AutoModerationRuleKeywordPresetType[],
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • presets: readonly AutoModerationRuleKeywordPresetType[]
  • Optionalreason: string

  Returns Promise<AutoModerationRule>

setRegexPatterns

• setRegexPatterns(
      regexPatterns: readonly string[],
      reason?: string,
  ): Promise<AutoModerationRule>

  Parameters

  • regexPatterns: readonly string[]
  • Optionalreason: string

  Returns Promise<AutoModerationRule>