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

MentionSpamAutoModerationRuleCreateBuilder

class MentionSpamAutoModerationRuleCreateBuilder(var name: String, var eventType: AutoModerationRuleEventType, var mentionLimit: Int) : AutoModerationRuleCreateBuilder, MentionSpamAutoModerationRuleBuilder(source)

A MentionSpamAutoModerationRuleBuilder for building AutoModerationRuleCreateRequests.

Constructors

constructor(name: String, eventType: AutoModerationRuleEventType, mentionLimit: Int)

Functions

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.

timeout

inline fun TimeoutAutoModerationRuleBuilder.timeout(duration: Duration, builder: TimeoutAutoModerationActionBuilder.() -> Unit = {})

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

toRequest

override fun toRequest(): AutoModerationRuleCreateRequest

Properties

actions

override var actions: MutableList<AutoModerationActionBuilder>

The actions which will execute when the rule is triggered.

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

mentionLimit

open override var mentionLimit: Int

Total number of unique role and user mentions allowed per message (maximum of 50).

name

override var name: String

The rule name.

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.