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

AutoModerationRuleBuilder

sealed interface AutoModerationRuleBuilder : AuditBuilder(source)

An AuditBuilder for building Auto Moderation Rules.

Auto Moderation is a feature which allows each guild to set up rules that trigger based on some criteria. For example, a rule can trigger whenever a message contains a specific keyword.

Rules can be configured to automatically execute actions whenever they trigger. For example, if a user tries to send a message which contains a certain keyword, a rule can trigger and block the message before it is sent.

Inheritors

TypedAutoModerationRuleBuilder

AutoModerationRuleModifyBuilder

Properties

abstract val actions: MutableList<AutoModerationActionBuilder>?

The actions which will execute when the rule is triggered.

abstract var enabled: Boolean?

Whether the rule is enabled (false by default).

abstract val eventType: AutoModerationRuleEventType?

The rule event type.

abstract var exemptChannels: MutableList<Snowflake>?

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

abstract var exemptRoles: MutableList<Snowflake>?

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

abstract val name: String?

The rule name.

abstract var reason: String?

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

abstract val triggerType: AutoModerationRuleTriggerType?

The rule trigger type.

Functions

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.

abstract fun assignName(name: String)

Use this to set name for AutoModerationRuleBuilder.

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

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

fun AutoModerationRuleBuilder.exemptChannel(channelId: Snowflake)

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

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.