kord-core/dev.kord.core.event.automoderation/AutoModerationActionExecutionEvent

AutoModerationActionExecutionEvent

class AutoModerationActionExecutionEvent(val data: AutoModerationActionExecutionEventData, val kord: Kord, val shard: Int, val customContext: Any?, val supplier: EntitySupplier = kord.defaultSupplier) : AutoModerationEvent(source)

An AutoModerationEvent that is sent when an AutoModerationRule is triggered and an AutoModerationAction is executed (e.g. when a message is blocked).

This event is only sent to bot users which have the ManageGuild permission.

Constructors

constructor(data: AutoModerationActionExecutionEventData, kord: Kord, shard: Int, customContext: Any?, supplier: EntitySupplier = kord.defaultSupplier)

Properties

action

val action: AutoModerationAction

The AutoModerationAction which was executed.

alertSystemMessage

val alertSystemMessage: MessageBehavior?

The behavior of any system Auto Moderation Message posted as a result of the action.

alertSystemMessageId

val alertSystemMessageId: Snowflake?

The ID of any system Auto Moderation Message posted as a result of the action.

channel

val channel: GuildMessageChannelBehavior?

The behavior of the GuildMessageChannel in which user content was posted.

channelId

val channelId: Snowflake?

The ID of the GuildMessageChannel in which user content was posted.

content

val content: String

The user generated text content.

customContext

open override val customContext: Any?

A custom object that can be inserted when creating events. By default, this is just null.

data

val data: AutoModerationActionExecutionEventData

gateway

open val gateway: Gateway

The Gateway that spawned this event.

guild

open val guild: GuildBehavior

The behavior of the Guild this event is for.

guildId

open override val guildId: Snowflake

The ID of the Guild in which the action was executed.

kord

open override val kord: Kord

The kord instance that created this object.

matchedContent

val matchedContent: String?

The substring in content that triggered the rule.

matchedKeyword

val matchedKeyword: String?

The word or phrase configured in the rule that triggered it.

member

val member: MemberBehavior

The behavior of the Member which generated the content which triggered the rule.

memberId

val memberId: Snowflake

The ID of the Member which generated the content which triggered the rule.

message

val message: MessageBehavior?

The behavior of any user Message which content belongs to.

messageId

val messageId: Snowflake?

The ID of any user Message which content belongs to.

rule

open override val rule: TypedAutoModerationRuleBehavior

The behavior of the AutoModerationRule which the action belongs to.

ruleId

open override val ruleId: Snowflake

The ID of the AutoModerationRule which the action belongs to.

shard

open override val shard: Int

The shard number of the gateway that spawned this event.

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

Functions

getGuild

open suspend fun getGuild(): Guild

Requests to get the Guild this event is for.

getGuildOrNull

open suspend fun getGuildOrNull(): Guild?

Requests to get the Guild this event is for. Returns null if it wasn't found.

toString

open override fun toString(): String

withStrategy

open override fun withStrategy(strategy: EntitySupplyStrategy<*>): AutoModerationActionExecutionEvent

Returns a copy of this class with a new supplier provided by the strategy.