kord-core/dev.kord.core.live.channel/LiveCategory

LiveCategory

class LiveCategory(channel: Category, coroutineScope: CoroutineScope = channel.kord + SupervisorJob(channel.kord.coroutineContext.job)) : LiveChannel, KordEntity(source)

Constructors

LiveCategory

constructor(channel: Category, coroutineScope: CoroutineScope = channel.kord + SupervisorJob(channel.kord.coroutineContext.job))

Properties

channel

open override var channel: Category

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.

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.

onChannelUpdate

@KordPreview

fun LiveChannel.onChannelUpdate(scope: CoroutineScope = this, block: suspend (ChannelUpdateEvent) -> Unit): Job

onGuildUpdate

@KordPreview

fun LiveChannel.onGuildUpdate(scope: CoroutineScope = this, block: suspend (GuildUpdateEvent) -> Unit): Job

onMessageCreate

@KordPreview

fun LiveChannel.onMessageCreate(scope: CoroutineScope = this, block: suspend (MessageCreateEvent) -> Unit): Job

onMessageDelete

@KordPreview

fun LiveChannel.onMessageDelete(scope: CoroutineScope = this, block: suspend (MessageDeleteEvent) -> Unit): Job

onMessageUpdate

@KordPreview

fun LiveChannel.onMessageUpdate(scope: CoroutineScope = this, block: suspend (MessageUpdateEvent) -> Unit): Job

onReactionAdd

@KordPreview

fun LiveChannel.onReactionAdd(scope: CoroutineScope = this, block: suspend (ReactionAddEvent) -> Unit): Job

@KordPreview

inline fun LiveChannel.onReactionAdd(reaction: ReactionEmoji, scope: CoroutineScope = this, crossinline block: suspend (ReactionAddEvent) -> Unit): Job

onReactionRemove

@KordPreview

fun LiveChannel.onReactionRemove(scope: CoroutineScope = this, block: suspend (ReactionRemoveEvent) -> Unit): Job

@KordPreview

inline fun LiveChannel.onReactionRemove(reaction: ReactionEmoji, scope: CoroutineScope = this, crossinline block: suspend (ReactionRemoveEvent) -> Unit): Job

onReactionRemoveAll

@KordPreview

fun LiveChannel.onReactionRemoveAll(scope: CoroutineScope = this, block: suspend (ReactionRemoveAllEvent) -> Unit): Job

onUpdate

@KordPreview

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

onVoiceStateUpdate

@KordPreview

fun LiveChannel.onVoiceStateUpdate(scope: CoroutineScope = this, block: suspend (VoiceStateUpdateEvent) -> Unit): Job

shutDown

open override fun shutDown(cause: CancellationException)