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
Content copied to clipboard

DSL for building a conversation.

Constructors

Link copied to clipboard
fun ConversationBuilder(    discord: Discord,     user: User,     channel: MessageChannel,     exitString: String? = null,     timeout: Long)
Content copied to clipboard

Functions

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

Prompt the user with text and/or embed.

Link copied to clipboard
abstract suspend fun <T> promptButton(prompt: suspend ButtonPromptBuilder<T>.() -> Unit): T
Content copied to clipboard

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

Link copied to clipboard
abstract suspend fun promptSelect(builder: SimpleSelectBuilder.() -> Unit): List<String>
Content copied to clipboard

Prompt the user with a select menu.

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

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

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

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

Link copied to clipboard
open suspend fun respondMenu(menuBuilder: suspend MenuBuilder.() -> Unit): Message
Content copied to clipboard

Respond with a Menu.

Properties

Link copied to clipboard
abstract val botMessageIds: MutableList<Snowflake>
Content copied to clipboard

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

Link copied to clipboard
open override val channel: MessageChannel
Content copied to clipboard

The channel that this entity was invoked in.

Link copied to clipboard
val discord: Discord
Content copied to clipboard
Link copied to clipboard
val previousBotMessageId: Snowflake
Content copied to clipboard

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

Link copied to clipboard
val previousUserMessageId: Snowflake
Content copied to clipboard

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

Link copied to clipboard
val responders: MutableList<ConversationResponder>
Content copied to clipboard

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

Link copied to clipboard
val user: User
Content copied to clipboard
Link copied to clipboard
abstract val userMessageIds: MutableList<Snowflake>
Content copied to clipboard

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

Inheritors

Link copied to clipboard