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

KeywordAutoModerationRule

class KeywordAutoModerationRule(val data: AutoModerationRuleData, val kord: Kord, val supplier: EntitySupplier) : AutoModerationRule, KeywordAutoModerationRuleBehavior(source)

An AutoModerationRule with trigger type Keyword.

Constructors

constructor(data: AutoModerationRuleData, kord: Kord, supplier: EntitySupplier)

Properties

actions

val actions: List<AutoModerationAction>

The actions which will execute when the rule is triggered.

allowedKeywords

val allowedKeywords: List<String>

Substrings which should not trigger the rule.

creator

val creator: MemberBehavior

The behavior of the Member which first created this rule.

creatorId

val creatorId: Snowflake

The ID of the Member which first created this rule.

data

val data: AutoModerationRuleData

eventType

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.

exemptChannels

val exemptChannels: List<GuildMessageChannelBehavior>

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

exemptRoleIds

val exemptRoleIds: List<Snowflake>

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

exemptRoles

val exemptRoles: List<RoleBehavior>

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

guild

open val guild: GuildBehavior

The behavior of the Guild which this rule belongs to.

guildId

override val guildId: Snowflake

The ID of the Guild which this rule belongs to.

override val id: Snowflake

The unique identifier of this entity.

isEnabled

val isEnabled: Boolean

Whether the rule is enabled.

keywords

val keywords: List<String>

Substrings which will be searched for in content.

kord

override val kord: Kord

The kord instance that created this object.

name

val name: String

The rule name.

regexPatterns

val regexPatterns: List<String>

Regular expression patterns which will be matched against content.

supplier

override val supplier: EntitySupplier

The supplier used to request entities.

triggerType

abstract override val triggerType: AutoModerationRuleTriggerType

The rule trigger type.

Functions

compareTo

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

Compares entities on id.

delete

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

Requests to delete this AutoModerationRule.

edit

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

Requests to edit this AutoModerationRule and returns the edited rule.

inline suspend fun KeywordAutoModerationRuleBehavior.edit(builder: KeywordAutoModerationRuleModifyBuilder.() -> Unit): KeywordAutoModerationRule

Requests to edit this KeywordAutoModerationRule and returns the edited rule.

equals

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

getGuild

open suspend fun getGuild(): Guild

Requests to get the Guild which this rule belongs to.

getGuildOrNull

open suspend fun getGuildOrNull(): Guild?

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

hashCode

override fun hashCode(): Int

toString

open override fun toString(): String

withStrategy

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

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