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

KeywordAutoModerationRuleBehavior

interface KeywordAutoModerationRuleBehavior : TypedAutoModerationRuleBehavior(source)

The behavior of a KeywordAutoModerationRule.

Inheritors

Properties

Link copied to clipboard
open val guild: GuildBehavior

The behavior of the Guild which this rule belongs to.

Link copied to clipboard
abstract val guildId: Snowflake

The ID of the Guild which this rule belongs to.

Link copied to clipboard
abstract val id: Snowflake

The unique identifier of this entity.

Link copied to clipboard
abstract val kord: Kord

The kord instance that created this object.

Link copied to clipboard
abstract val supplier: EntitySupplier

The supplier used to request entities.

Link copied to clipboard

Functions

Link copied to clipboard
open suspend override fun asAutoModerationRule(): KeywordAutoModerationRule

Requests to get this behavior as a KeywordAutoModerationRule.

Link copied to clipboard
open suspend override fun asAutoModerationRuleOrNull(): KeywordAutoModerationRule?

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

Link copied to clipboard
open operator override fun compareTo(other: Entity): Int

Compares entities on id.

Link copied to clipboard
open suspend fun delete(reason: String? = null)

Requests to delete this AutoModerationRule.

Link copied to clipboard
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.

Link copied to clipboard
abstract operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open suspend fun getGuild(): Guild

Requests to get the Guild which this rule belongs to.

Link copied to clipboard
open suspend fun getGuildOrNull(): Guild?

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

Link copied to clipboard
abstract override fun hashCode(): Int
Link copied to clipboard
abstract override fun toString(): String
Link copied to clipboard
abstract override fun withStrategy(strategy: EntitySupplyStrategy<*>): KeywordAutoModerationRuleBehavior

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