kord-rest/dev.kord.rest.builder.automoderation/KeywordPresetAutoModerationRuleCreateBuilder

KeywordPresetAutoModerationRuleCreateBuilder

class KeywordPresetAutoModerationRuleCreateBuilder(var name: String, var eventType: AutoModerationRuleEventType) : AutoModerationRuleCreateBuilder, KeywordPresetAutoModerationRuleBuilder(source)

A KeywordPresetAutoModerationRuleBuilder for building AutoModerationRuleCreateRequests.

Constructors

constructor(name: String, eventType: AutoModerationRuleEventType)

Properties

actions

override var actions: MutableList<AutoModerationActionBuilder>

The actions which will execute when the rule is triggered.

allowedKeywords

open override var allowedKeywords: MutableList<String>?

Substrings which should not trigger the rule.

enabled

override var enabled: Boolean?

Whether the rule is enabled (false by default).

eventType

override var eventType: AutoModerationRuleEventType

The rule event type.

exemptChannels

override var exemptChannels: MutableList<Snowflake>?

The IDs of the channels that should not be affected by the rule (maximum of 50).

exemptRoles

override var exemptRoles: MutableList<Snowflake>?

The IDs of the roles that should not be affected by the rule (maximum of 20).

name

override var name: String

The rule name.

presets

open override var presets: MutableList<AutoModerationRuleKeywordPresetType>

The internally pre-defined wordsets which will be searched for in content.

reason

override var reason: String?

The reason for this request, this will be displayed in the audit log.

triggerType

abstract override val triggerType: AutoModerationRuleTriggerType

The rule trigger type.

Functions

allowAnywhereKeyword

fun AllowedKeywordsAutoModerationRuleBuilder.allowAnywhereKeyword(keyword: String)

Add a keyword with keyword matching strategy Anywhere to allowedKeywords.

allowKeyword

fun AllowedKeywordsAutoModerationRuleBuilder.allowKeyword(keyword: String)

Add a keyword to allowedKeywords.

allowPrefixKeyword

fun AllowedKeywordsAutoModerationRuleBuilder.allowPrefixKeyword(keyword: String)

Add a keyword with keyword matching strategy Prefix to allowedKeywords.

allowSuffixKeyword

fun AllowedKeywordsAutoModerationRuleBuilder.allowSuffixKeyword(keyword: String)

Add a keyword with keyword matching strategy Suffix to allowedKeywords.

blockMessage

inline fun AutoModerationRuleBuilder.blockMessage(builder: BlockMessageAutoModerationActionBuilder.() -> Unit = {})

Add a BlockMessage action which will execute whenever the rule is triggered.

exemptChannel

fun AutoModerationRuleBuilder.exemptChannel(channelId: Snowflake)

Exempt a channel from being affected by the rule (maximum of 50).

exemptRole

fun AutoModerationRuleBuilder.exemptRole(roleId: Snowflake)

Exempt a role from being affected by the rule (maximum of 20).

preset

fun KeywordPresetAutoModerationRuleBuilder.preset(preset: AutoModerationRuleKeywordPresetType)

Add a preset to presets.

sendAlertMessage

inline fun AutoModerationRuleBuilder.sendAlertMessage(channelId: Snowflake, builder: SendAlertMessageAutoModerationActionBuilder.() -> Unit = {})

Add a SendAlertMessage action which will execute whenever the rule is triggered.

toRequest

override fun toRequest(): AutoModerationRuleCreateRequest