kord-core/dev.kord.core.behavior.interaction/ComponentInteractionBehavior

ComponentInteractionBehavior

interface ComponentInteractionBehavior : ActionInteractionBehavior(source)

The behavior of a ComponentInteraction or a ModalSubmitInteraction that contains a message.

Inheritors

ComponentInteraction

ModalSubmitInteraction

Properties

applicationId

abstract val applicationId: Snowflake

The id of the application the interaction is for.

channel

open val channel: MessageChannelBehavior

The behavior of the channel the interaction was sent from.

channelId

abstract val channelId: Snowflake

The id of the channel the interaction was sent from.

abstract val id: Snowflake

The unique identifier of this entity.

kord

abstract val kord: Kord

The kord instance that created this object.

supplier

abstract val supplier: EntitySupplier

The supplier used to request entities.

token

abstract val token: String

A continuation token for responding to the interaction.

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.

getChannel

open suspend fun getChannel(): MessageChannel

getChannelOrNull

open suspend fun getChannelOrNull(): MessageChannel?

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.

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.

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<*>): ComponentInteractionBehavior

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