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

GuildScheduledEventCreateEvent

data class GuildScheduledEventCreateEvent(val scheduledEvent: GuildScheduledEvent, val kord: Kord, val shard: Int, val customContext: Any?, val supplier: EntitySupplier = kord.defaultSupplier) : GuildScheduledEventEvent(source)

Event fired when a scheduled event got created.

See also

Constructors

Link copied to clipboard
constructor(scheduledEvent: GuildScheduledEvent, kord: Kord, shard: Int, customContext: Any?, supplier: EntitySupplier = kord.defaultSupplier)

Properties

Link copied to clipboard
open val channelId: Snowflake?

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

Link copied to clipboard
open override 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
open override val kord: Kord

The kord instance that created this object.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val shard: Int

The shard number of the gateway that spawned this event.

Link copied to clipboard
open override 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
open override fun withStrategy(strategy: EntitySupplyStrategy<*>): GuildScheduledEventCreateEvent

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