kord-core/dev.kord.core.behavior.automoderation/KeywordPresetAutoModerationRuleBehavior

KeywordPresetAutoModerationRuleBehavior

interface KeywordPresetAutoModerationRuleBehavior : TypedAutoModerationRuleBehavior(source)

The behavior of a KeywordPresetAutoModerationRule.

Inheritors

KeywordPresetAutoModerationRule

Properties

open val guild: GuildBehavior

The behavior of the Guild which this rule belongs to.

abstract val guildId: Snowflake

The ID of the Guild which this rule belongs to.

abstract val id: Snowflake

The unique identifier of this entity.

abstract val kord: Kord

The kord instance that created this object.

abstract val supplier: EntitySupplier

The supplier used to request entities.

open override val triggerType: AutoModerationRuleTriggerType.KeywordPreset

The rule trigger type.

Functions

asAutoModerationRule

open suspend override fun asAutoModerationRule(): KeywordPresetAutoModerationRule

Requests to get this behavior as a KeywordPresetAutoModerationRule.

asAutoModerationRuleOrNull

open suspend override fun asAutoModerationRuleOrNull(): KeywordPresetAutoModerationRule?

Requests to get this behavior as a KeywordPresetAutoModerationRule. Returns null if it wasn't found or if the rule isn't a KeywordPresetAutoModerationRule.

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.

inline suspend fun KeywordPresetAutoModerationRuleBehavior.edit(builder: KeywordPresetAutoModerationRuleModifyBuilder.() -> Unit): KeywordPresetAutoModerationRule

Requests to edit this KeywordPresetAutoModerationRule and returns the edited rule.

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

abstract override fun hashCode(): Int

abstract override fun toString(): String

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

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