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

SpamAutoModerationRuleBuilder

sealed interface SpamAutoModerationRuleBuilder : TypedAutoModerationRuleBuilder(source)

An AutoModerationRuleBuilder for building rules with trigger type Spam.

Inheritors

SpamAutoModerationRuleCreateBuilder

SpamAutoModerationRuleModifyBuilder

Properties

actions

abstract val actions: MutableList<AutoModerationActionBuilder>?

The actions which will execute when the rule is triggered.

enabled

abstract var enabled: Boolean?

Whether the rule is enabled (false by default).

eventType

abstract val eventType: AutoModerationRuleEventType?

The rule event type.

exemptChannels

abstract var exemptChannels: MutableList<Snowflake>?

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

exemptRoles

abstract var exemptRoles: MutableList<Snowflake>?

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

name

abstract val name: String?

The rule name.

reason

abstract var reason: String?

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

triggerType

open override val triggerType: AutoModerationRuleTriggerType.Spam

The rule trigger type.

Functions

assignActions

abstract fun assignActions(actions: MutableList<AutoModerationActionBuilder>)

Use this to set actions for AutoModerationRuleBuilder.

assignEventType

abstract fun assignEventType(eventType: AutoModerationRuleEventType)

Use this to set eventType for AutoModerationRuleBuilder.

assignName

abstract fun assignName(name: String)

Use this to set name for AutoModerationRuleBuilder.

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).

sendAlertMessage

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

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