commonMain.event.guild.GuildScheduledEventUpdateEvent.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kord-core Show documentation

Idiomatic Kotlin Wrapper for The Discord API

There is a newer version: 0.15.0

package dev.kord.core.event.guild

import dev.kord.common.entity.Snowflake
import dev.kord.common.exception.RequestException
import dev.kord.core.Kord
import dev.kord.core.entity.GuildScheduledEvent
import dev.kord.core.entity.channel.TopGuildChannel
import dev.kord.core.supplier.EntitySupplier
import dev.kord.core.supplier.EntitySupplyStrategy

/**
 * Event fired if a [GuildScheduledEvent] gets updated.
 *
 * @property scheduledEvent the updated event, for the old event use [oldEvent]
 * @property oldEvent the event that was in the cache before the update
 *
 * @see GuildScheduledEvent
 * @see GuildScheduledEventEvent
 */
public data class GuildScheduledEventUpdateEvent(
    override val scheduledEvent: GuildScheduledEvent,
    public val oldEvent: GuildScheduledEvent?,
    override val kord: Kord,
    override val shard: Int,
    override val customContext: Any?,
    override val supplier: EntitySupplier = kord.defaultSupplier,
) : GuildScheduledEventEvent {

    /**
     * The channel id of the channel the event is in.
     *
     * **Note:** This is going to represent the channel of [scheduledEvent] for the previous channel use [oldEvent]
     */
    override val channelId: Snowflake?
        get() = super.channelId

    /**
     * Requests the [TopGuildChannel] this event is in,
     * returns null if the [TopGuildChannel] isn't present or not set.
     *
     * **Note:** This is going to represent the channel of [scheduledEvent] for the previous channel use [oldEvent]
     * @throws [RequestException] if anything went wrong during the request.
     */
    override suspend fun getChannelOrNull(): TopGuildChannel? = super.getChannelOrNull()

    override fun withStrategy(strategy: EntitySupplyStrategy<*>): GuildScheduledEventUpdateEvent =
        copy(supplier = strategy.supply(kord))
}