kord-core/dev.kord.core.live/LiveGuild

LiveGuild

class LiveGuild(guild: Guild, coroutineScope: CoroutineScope = guild.kord + SupervisorJob(guild.kord.coroutineContext.job)) : AbstractLiveKordEntity, KordEntity(source)

Constructors

LiveGuild

constructor(guild: Guild, coroutineScope: CoroutineScope = guild.kord + SupervisorJob(guild.kord.coroutineContext.job))

Properties

coroutineContext

override val coroutineContext: CoroutineContext

events

override val events: SharedFlow<Event>

guild

var guild: Guild

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.

onBanAdd

@KordPreview

fun LiveGuild.onBanAdd(scope: CoroutineScope = this, block: suspend (BanAddEvent) -> Unit): Job

onBanRemove

@KordPreview

fun LiveGuild.onBanRemove(scope: CoroutineScope = this, block: suspend (BanRemoveEvent) -> Unit): Job

onChannelCreate

@KordPreview

fun LiveGuild.onChannelCreate(scope: CoroutineScope = this, block: suspend (ChannelCreateEvent) -> Unit): Job

onChannelDelete

@KordPreview

fun LiveGuild.onChannelDelete(scope: CoroutineScope = this, block: suspend (ChannelDeleteEvent) -> Unit): Job

onChannelUpdate

@KordPreview

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

onEmojisUpdate

@KordPreview

fun LiveGuild.onEmojisUpdate(scope: CoroutineScope = this, block: suspend (EmojisUpdateEvent) -> Unit): Job

onGuildCreate

@KordPreview

fun LiveGuild.onGuildCreate(scope: CoroutineScope = this, block: suspend (GuildCreateEvent) -> Unit): Job

onGuildUpdate

@KordPreview

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

onIntegrationsUpdate

@KordPreview

fun LiveGuild.onIntegrationsUpdate(scope: CoroutineScope = this, block: suspend (IntegrationsUpdateEvent) -> Unit): Job

onMemberJoin

@KordPreview

fun LiveGuild.onMemberJoin(scope: CoroutineScope = this, block: suspend (MemberJoinEvent) -> Unit): Job

onMemberLeave

@KordPreview

fun LiveGuild.onMemberLeave(scope: CoroutineScope = this, block: suspend (MemberLeaveEvent) -> Unit): Job

onMemberUpdate

@KordPreview

fun LiveGuild.onMemberUpdate(scope: CoroutineScope = this, block: suspend (MemberUpdateEvent) -> Unit): Job

onMessageCreate

@KordPreview

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

onMessageDelete

@KordPreview

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

onMessageUpdate

@KordPreview

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

onPresenceUpdate

@KordPreview

fun LiveGuild.onPresenceUpdate(scope: CoroutineScope = this, block: suspend (PresenceUpdateEvent) -> Unit): Job

onReactionAdd

@KordPreview

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

@KordPreview

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

onReactionRemove

@KordPreview

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

@KordPreview

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

onReactionRemoveAll

@KordPreview

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

onRoleCreate

@KordPreview

fun LiveGuild.onRoleCreate(scope: CoroutineScope = this, block: suspend (RoleCreateEvent) -> Unit): Job

onRoleDelete

@KordPreview

fun LiveGuild.onRoleDelete(scope: CoroutineScope = this, block: suspend (RoleDeleteEvent) -> Unit): Job

onRoleUpdate

@KordPreview

fun LiveGuild.onRoleUpdate(scope: CoroutineScope = this, block: suspend (RoleUpdateEvent) -> Unit): Job

onVoiceServerUpdate

@KordPreview

fun LiveGuild.onVoiceServerUpdate(scope: CoroutineScope = this, block: suspend (VoiceServerUpdateEvent) -> Unit): Job

onVoiceStateUpdate

@KordPreview

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

onWebhookUpdate

@KordPreview

fun LiveGuild.onWebhookUpdate(scope: CoroutineScope = this, block: suspend (WebhookUpdateEvent) -> Unit): Job

shutDown

open override fun shutDown(cause: CancellationException)