kord-core/dev.kord.core.live/LiveRole

LiveRole

class LiveRole(role: Role, coroutineScope: CoroutineScope = role.kord + SupervisorJob(role.kord.coroutineContext.job)) : AbstractLiveKordEntity, KordEntity(source)

Constructors

LiveRole

constructor(role: Role, coroutineScope: CoroutineScope = role.kord + SupervisorJob(role.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.

role

var role: Role

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 LiveRole.onUpdate(scope: CoroutineScope = this, block: suspend (RoleUpdateEvent) -> Unit): Job

shutDown

open override fun shutDown(cause: CancellationException)