kord-core/dev.kord.core.event.guild/GuildScheduledEventEvent

GuildScheduledEventEvent

sealed interface GuildScheduledEventEvent : Event, Strategizable(source)

Interface of all events related to GuildScheduledEvents.

See also

Inheritors

Properties

Link copied to clipboard
open val channelId: Snowflake?

The id of the channel the event is in, if any.

Link copied to clipboard
@KordPreview
abstract val customContext: Any?

A custom object that can be inserted when creating events. By default, this is just null.

Link copied to clipboard
open val gateway: Gateway

The Gateway that spawned this event.

Link copied to clipboard
open val guildId: Snowflake

The id of the guild the event is on.

Link copied to clipboard
abstract val kord: Kord

The kord instance that created this object.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract val shard: Int

The shard number of the gateway that spawned this event.

Link copied to clipboard
abstract val supplier: EntitySupplier

The supplier used to request entities.

Functions

Link copied to clipboard
open suspend fun getChannelOrNull(): TopGuildChannel?

Requests the TopGuildChannel this event is in, returns null if the TopGuildChannel isn't present or not set.

Link copied to clipboard
open suspend fun getGuild(): Guild

Requests the Guild this event is on.

Link copied to clipboard
open suspend fun getGuildOrNull(): Guild?

Requests the Guild this event is on, returns null if the Guild isn't present.

Link copied to clipboard
abstract override fun withStrategy(strategy: EntitySupplyStrategy<*>): GuildScheduledEventEvent

Returns a copy of this class with a new supplier provided by the strategy.