kord-core/dev.kord.core.live/LiveUser

LiveUser

@KordPreview

class LiveUser(user: User, coroutineScope: CoroutineScope = user.kord + SupervisorJob(user.kord.coroutineContext.job)) : AbstractLiveKordEntity, KordEntity(source)

Constructors

LiveUser

constructor(user: User, coroutineScope: CoroutineScope = user.kord + SupervisorJob(user.kord.coroutineContext.job))

Properties

coroutineContext

override val coroutineContext: CoroutineContext

events

override val events: SharedFlow<Event>

open override val id: Snowflake

The unique identifier of this entity.

kord

override val kord: Kord

The kord instance that created this object.

user

var user: User

Functions

compareTo

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

Compares entities on id.

@KordPreview

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.

onUpdate

@KordPreview

fun LiveUser.onUpdate(scope: CoroutineScope = this, block: suspend (UserUpdateEvent) -> Unit): Job

shutDown

open override fun shutDown(cause: CancellationException)