DiscordKt/me.jakejmattson.discordkt.conversations/ConversationBuilder

ConversationBuilder

abstract class ConversationBuilder(val discord: Discord, val user: User, val channel: MessageChannel, exitString: String? = null, timeout: Long) : Responder

DSL for building a conversation.

Inheritors

SlashConversationBuilder

Constructors

ConversationBuilder

constructor(discord: Discord, user: User, channel: MessageChannel, exitString: String? = null, timeout: Long)

Properties

botMessageIds

abstract val botMessageIds: MutableList<Snowflake>

All ID's of messages sent by the bot in this conversation.

channel

open override val channel: MessageChannel

The channel that this entity was invoked in.

discord

val discord: Discord

previousBotMessageId

val previousBotMessageId: Snowflake

The ID of the most recent message sent by the bot in this conversation.

previousUserMessageId

val previousUserMessageId: Snowflake

The ID of the most recent message sent by the user in this conversation.

responders

val responders: MutableList<ConversationResponder>

All responder objects that have been used to respond to user messages/interactions.

user

val user: User

userMessageIds

abstract val userMessageIds: MutableList<Snowflake>

All ID's of messages sent by the user in this conversation.

Functions

prompt

abstract suspend fun <I, O> prompt(argument: Argument<I, O>, text: String = "", embed: suspend EmbedBuilder.() -> Unit? = null): O

Prompt the user with text and/or embed.

promptButton

abstract suspend fun <T> promptButton(prompt: suspend ButtonPromptBuilder<T>.() -> Unit): T

Prompt the user with an embed and the provided buttons. Requires a call to both ButtonPromptBuilder.embed and ButtonPromptBuilder.buttons.

promptSelect

abstract suspend fun promptSelect(builder: SimpleSelectBuilder.() -> Unit): List<String>

Prompt the user with a select menu.

promptUntil

abstract suspend fun <T> promptUntil(argument: Argument<*, T>, prompt: String, error: String, isValid: (T) -> Boolean): T

Prompt the user with a String. Re-prompt until the response converts correctly. Then apply a custom predicate as an additional check.

respond

open suspend fun respond(message: Any = "", embed: suspend EmbedBuilder.() -> Unit? = null): Message?

Create a response message with text and/or an embed.

respondMenu

open suspend fun respondMenu(menuBuilder: suspend MenuBuilder.() -> Unit): Message

Respond with a Menu.