kord-core/dev.kord.core.entity.automoderation/AutoModerationRule

AutoModerationRule

sealed class AutoModerationRule : TypedAutoModerationRuleBehavior(source)

An instance of an Auto Moderation Rule.

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

KeywordAutoModerationRule

SpamAutoModerationRule

KeywordPresetAutoModerationRule

MentionSpamAutoModerationRule

MemberProfileAutoModerationRule

UnknownAutoModerationRule

Properties

val actions: List<AutoModerationAction>

The actions which will execute when the rule is triggered.

val creator: MemberBehavior

The behavior of the Member which first created this rule.

val creatorId: Snowflake

The ID of the Member which first created this rule.

val data: AutoModerationRuleData

val eventType: AutoModerationRuleEventType

The rule event type.

exemptChannelIds

val exemptChannelIds: List<Snowflake>

The IDs of the GuildMessageChannels that should not be affected by the rule.

val exemptChannels: List<GuildMessageChannelBehavior>

The behaviors of the GuildMessageChannels that should not be affected by the rule.

val exemptRoleIds: List<Snowflake>

The IDs of the Roles that should not be affected by the rule.

val exemptRoles: List<RoleBehavior>

The behaviors of the Roles that should not be affected by the rule.

open val guild: GuildBehavior

The behavior of the Guild which this rule belongs to.

override val guildId: Snowflake

The ID of the Guild which this rule belongs to.

override val id: Snowflake

The unique identifier of this entity.

val isEnabled: Boolean

Whether the rule is enabled.

override val kord: Kord

The kord instance that created this object.

val name: String

The rule name.

override val supplier: EntitySupplier

The supplier used to request entities.

abstract override val triggerType: AutoModerationRuleTriggerType

The rule trigger type.

Functions

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

open suspend fun delete(reason: String? = null)

Requests to delete this AutoModerationRule.

inline suspend fun AutoModerationRuleBehavior.edit(builder: UntypedAutoModerationRuleModifyBuilder.() -> Unit): AutoModerationRule

Requests to edit this AutoModerationRule and returns the edited rule.

operator override fun equals(other: Any?): Boolean

open suspend fun getGuild(): Guild

Requests to get the Guild which this rule belongs to.

open suspend fun getGuildOrNull(): Guild?

Requests to get the Guild which this rule belongs to. Returns null if it wasn't found.

override fun hashCode(): Int

abstract override fun toString(): String

abstract override fun withStrategy(strategy: EntitySupplyStrategy<*>): AutoModerationRule

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