kord-core/dev.kord.core.entity.interaction/GuildButtonInteraction

GuildButtonInteraction

class GuildButtonInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : ButtonInteraction, GuildComponentInteraction(source)

A ButtonInteraction that took place in the context of a Guild.

Constructors

constructor(data: InteractionData, kord: Kord, supplier: EntitySupplier)

Properties

applicationId

open override val applicationId: Snowflake

The id of the application the interaction is for.

appPermissions

open val appPermissions: Permissions

Permissions the application has within the channel the interaction was sent from.

channel

open val channel: MessageChannelBehavior

The behavior of the channel the interaction was sent from.

channelId

open override val channelId: Snowflake

The id of the channel the interaction was sent from.

component

open override val component: ButtonComponent

The Component that triggered the interaction.

componentId

open val componentId: String

The custom id of the component.

componentType

open val componentType: ComponentType

The type of the component.

data

open override val data: InteractionData

entitlements

open val entitlements: List<Entitlement>

For monetized apps, any Entitlements for the invoking user, representing access to premium Skus.

guild

open val guild: GuildBehavior

The behavior of the guild the interaction was sent from.

guildId

open override val guildId: Snowflake

The id of the guild the interaction was sent from.

guildLocale

open val guildLocale: Locale?

The guild's preferred locale, if invoked in a guild.

open override val id: Snowflake

The unique identifier of this entity.

kord

open override val kord: Kord

The kord instance that created this object.

locale

open val locale: Locale?

The selected language of the invoking user.

message

open val message: Message

The message the component is attached to.

permissions

open val permissions: Permissions

Permissions the interaction invoker has within the channel the interaction was sent from.

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

token

open override val token: String

A continuation token for responding to the interaction.

type

open val type: InteractionType

The type of the interaction.

user

abstract val user: User

The invoker of the interaction.

version

open val version: Int

read-only property, always 1

Functions

compareTo

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

deferEphemeralMessageUpdate

open suspend fun deferEphemeralMessageUpdate(): EphemeralMessageInteractionResponseBehavior

Acknowledges the interaction with the intent of updating the original ephemeral message later by calling edit on the returned object.

deferEphemeralResponse

open suspend fun deferEphemeralResponse(): DeferredEphemeralMessageInteractionResponseBehavior

Acknowledges the interaction with the intent of responding with an ephemeral message later by calling respond on the returned object.

deferEphemeralResponseUnsafe

@KordUnsafe

open suspend fun deferEphemeralResponseUnsafe(): EphemeralMessageInteractionResponseBehavior

Acknowledges the interaction with the intent of responding with an ephemeral message later by calling edit on the returned object.

deferPublicMessageUpdate

open suspend fun deferPublicMessageUpdate(): PublicMessageInteractionResponseBehavior

Acknowledges the interaction with the intent of updating the original public message later by calling edit on the returned object.

deferPublicResponse

open suspend fun deferPublicResponse(): DeferredPublicMessageInteractionResponseBehavior

Acknowledges the interaction with the intent of responding with a public message later by calling respond on the returned object.

deferPublicResponseUnsafe

@KordUnsafe

open suspend fun deferPublicResponseUnsafe(): PublicMessageInteractionResponseBehavior

Acknowledges the interaction with the intent of responding with a public message later by calling edit on the returned object.

equals

open operator override fun equals(other: Any?): Boolean

getChannel

open suspend fun getChannel(): MessageChannel

getChannelOrNull

open suspend fun getChannelOrNull(): MessageChannel?

getGuild

open suspend fun getGuild(): Guild

getGuildOrNull

open suspend fun getGuildOrNull(): Guild?

getOriginalInteractionResponse

open suspend fun getOriginalInteractionResponse(): Message

Returns the initial interaction response.

getOriginalInteractionResponseOrNull

open suspend fun getOriginalInteractionResponseOrNull(): Message?

Returns the initial interaction response or null if it was not found.

hashCode

open override fun hashCode(): Int

modal

inline suspend fun ModalParentInteractionBehavior.modal(title: String, customId: String, builder: ModalBuilder.() -> Unit): PopupInteractionResponseBehavior

Responds to the interaction with a popup modal.

respondEphemeral

inline suspend fun ActionInteractionBehavior.respondEphemeral(builder: InteractionResponseCreateBuilder.() -> Unit): EphemeralMessageInteractionResponseBehavior

Responds to the interaction with an ephemeral message.

respondPublic

inline suspend fun ActionInteractionBehavior.respondPublic(builder: InteractionResponseCreateBuilder.() -> Unit): PublicMessageInteractionResponseBehavior

Responds to the interaction with a public message.

toString

open override fun toString(): String

updateEphemeralMessage

inline suspend fun ComponentInteractionBehavior.updateEphemeralMessage(builder: UpdateMessageInteractionResponseCreateBuilder.() -> Unit): EphemeralMessageInteractionResponseBehavior

Responds to the interaction by updating the original ephemeral message.

updatePublicMessage

inline suspend fun ComponentInteractionBehavior.updatePublicMessage(builder: UpdateMessageInteractionResponseCreateBuilder.() -> Unit): PublicMessageInteractionResponseBehavior

Responds to the interaction by updating the original public message.

withStrategy

open override fun withStrategy(strategy: EntitySupplyStrategy<*>): GuildButtonInteraction

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