kord-core/dev.kord.core.live/LiveKordEntity

LiveKordEntity

interface LiveKordEntity : KordEntity, CoroutineScope(source)

A Discord entity that only emits events related to this entity.

For example, a LiveMessage will only emit MessageUpdateEvents of that message, and only emit reactions to that message.

Inheritors

AbstractLiveKordEntity

Properties

coroutineContext

abstract val coroutineContext: CoroutineContext

abstract val events: Flow<Event>

abstract val id: Snowflake

The unique identifier of this entity.

abstract val kord: Kord

The kord instance that created this object.

Functions

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

Compares entities on id.

inline fun <T : Event> LiveKordEntity.on(scope: CoroutineScope = this, noinline consumer: suspend (T) -> Unit): Job

Convenience method that will invoke the consumer on every event T, the consumer is launched in the given scope or Kord by default and will not propagate any exceptions.

abstract fun shutDown(cause: CancellationException = CancellationException("The live entity is shut down", null))