commonMain.entity.interaction.ButtonInteraction.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.entity.interaction

import dev.kord.core.Kord
import dev.kord.core.cache.data.InteractionData
import dev.kord.core.entity.Guild
import dev.kord.core.entity.component.ButtonComponent
import dev.kord.core.supplier.EntitySupplier
import dev.kord.core.supplier.EntitySupplyStrategy

/** A [ComponentInteraction] created when a user presses a [button][ButtonComponent]. */
public sealed interface ButtonInteraction : ComponentInteraction {

    override val component: ButtonComponent
        get() = message.actionRows.firstNotNullOf { it.interactionButtons[componentId] }

    override fun withStrategy(strategy: EntitySupplyStrategy<*>): ButtonInteraction
}

/** A [ButtonInteraction] that took place in a global context (e.g. a DM). */
public class GlobalButtonInteraction(
    override val data: InteractionData,
    override val kord: Kord,
    override val supplier: EntitySupplier
) : ButtonInteraction, GlobalComponentInteraction {

    override fun withStrategy(strategy: EntitySupplyStrategy<*>): GlobalButtonInteraction =
        GlobalButtonInteraction(data, kord, strategy.supply(kord))

    override fun equals(other: Any?): Boolean = other is GlobalButtonInteraction && this.id == other.id
    override fun hashCode(): Int = id.hashCode()
    override fun toString(): String =
        "GlobalButtonInteraction(data=$data, kord=$kord, supplier=$supplier)"
}

/** A [ButtonInteraction] that took place in the context of a [Guild]. */
public class GuildButtonInteraction(
    override val data: InteractionData,
    override val kord: Kord,
    override val supplier: EntitySupplier
) : ButtonInteraction, GuildComponentInteraction {

    override fun withStrategy(strategy: EntitySupplyStrategy<*>): GuildButtonInteraction =
        GuildButtonInteraction(data, kord, strategy.supply(kord))

    override fun equals(other: Any?): Boolean = other is GuildButtonInteraction && this.id == other.id
    override fun hashCode(): Int = id.hashCode()
    override fun toString(): String =
        "GuildButtonInteraction(data=$data, kord=$kord, supplier=$supplier)"
}