diskord-bot/com.jessecorbett.diskord.bot.interaction/ResponseContext

ResponseContext

data class ResponseContext<I : Interaction> : BotContext(source)

The action scope of the response to an Interaction.

Types

ResponseBuilder

class ResponseBuilder

Convenience class for building a message response

Properties

botUser

open override val botUser: User

channel

open override val Message.channel: ChannelClient

Create an instance of a channel client for the Message.channelId

client

open override val client: RestClient

client

open override val Interaction.client: InteractionClient

Get the interaction client from an interaction

command

val command: I

The instance of the command the interaction is for

data

val data: CommandInteractionDataResolved?

The resolved data relative to the options

guild

open override val Message.guild: GuildClient?

Create an instance of a guild client for the Message.channelId or null if there is no guild

options

val options: List<CommandInteractionOptionResponse>

The parameters passed from the Discord user via the command

Functions

acknowledgeForFutureResponse

suspend fun acknowledgeForFutureResponse(ephemeral: Boolean = false)

Acknowledges the interaction and informs the user and Discord that a response will be coming shortly

channel

open override fun channel(channelId: String): ChannelClient

Create an instance of a channel client

command

open override fun command(applicationId: String): CommandClient

Create an instance of a command client

createModal

suspend fun Interaction.createModal(title: String, vararg inputs: TextInput, callback: suspend ResponseContext<ModalSubmit>.(ModalSubmit) -> Unit)

Respond to the interaction by creating a modal for the user

delete

open suspend override fun Message.delete()

Deletes the message

deleteOriginalResponse

suspend fun Interaction.deleteOriginalResponse()

Deletes the original interaction response

edit

open suspend override fun Message.edit(messageEdit: MessageEdit)

Edit this message

global

open override fun global(): GlobalClient

Create an instance of the global client

guild

open override fun guild(guildId: String): GuildClient

Create an instance of a guild client

interaction

open override fun interaction(applicationId: String, interactionToken: String): InteractionClient

Create an instance of an interaction client

invite

open override fun invite(inviteCode: String): InviteClient

Create an instance of an invite client

react

open suspend override fun Message.react(emoji: String)

Add a reaction to this message.

open suspend override fun Message.reply(message: String): Message

open suspend override fun Message.reply(message: String, block: Embed.() -> Unit): Message

Sends a reply to an existing message using the Discord reply feature.

replyEmbed

open suspend override fun Message.~~replyEmbed~~(message: String, block: Embed.() -> Unit): Message

Sends a reply to an existing message using the Discord reply feature.

respond

suspend fun respond(builder: suspend ResponseContext.ResponseBuilder.() -> Unit)

Responds to the interaction with a channel message

respond

open suspend override fun Message.respond(message: String): Message

Send a message in the same channel as this message.

open suspend override fun Message.respond(message: String, block: Embed.() -> Unit): Message

Send an embed in the same channel as this message.

respondAndDelete

open suspend override fun Message.respondAndDelete(message: String): Message

open suspend override fun Message.respondAndDelete(message: String, block: Embed.() -> Unit): Message

Send a message in the same channel as this message and delete the original message.

respondEmbed

open suspend override fun Message.~~respondEmbed~~(message: String, block: Embed.() -> Unit): Message

Send an embed in the same channel as this message.

webhook

open override fun webhook(webhookId: String): WebhookClient

Create an instance of a webhook client