kord-extensions/dev.kordex.core.commands.converters.impl/MessageConverter

MessageConverter

class MessageConverter(requireGuild: Boolean = false, requiredGuild: suspend () -> Snowflake? = null, useReply: Boolean = true, var validator: Validator<Message> = null) : SingleConverter<Message>

Argument converter for discord Message arguments.

This converter supports specifying messages by supplying:

A Discord message jump link
A message ID (it will be assumed that the message is in the current channel).

Parameters

requireGuild

Whether to require messages to be in a specified guild.

requiredGuild

Lambda returning a specific guild to require the member to be in. If omitted, defaults to the guild the command was invoked in.

useReply

Whether to use the replied-to message (if there is one) instead of trying to parse an argument.

Constructors

MessageConverter

constructor(requireGuild: Boolean = false, requiredGuild: suspend () -> Snowflake? = null, useReply: Boolean = true, validator: Validator<Message> = null)

Properties

argumentObj

open lateinit var argumentObj: Argument<*>

Argument object containing this converter and its metadata.

bot

open val bot: ExtensibleBot

Current instance of the bot.

builder

open lateinit var builder: ConverterBuilder<Message>

Access to the converter builder, perhaps a bit more hacky than it should be but whatever.

errorType

open val errorType: Key?

If the signatureType isn't sufficient, you can optionally provide a translation key pointing to a longer type string to use for error messages.

kord

val kord: Kord

Kord instance, backing the ExtensibleBot.

parsed

open lateinit override var parsed: Message

The parsed value.

parseSuccess

var parseSuccess: Boolean

This will be set to true by the argument parser if the conversion succeeded.

required

open override val required: Boolean

showTypeInSignature

open val showTypeInSignature: Boolean

For commands with generated signatures, set whether the type string should be shown in the signature.

signatureType

open override val signatureType: Key

Translation key pointing to a short string describing the type of data this converter handles. Should be very short.

validator

open override var validator: Validator<Message>

Validation lambda, which may throw a DiscordRelayedException if required.

Functions

getErrorKey

open suspend fun getErrorKey(): Key

Return a Key representing a pre-translated error string.

getErrorString

open suspend fun getErrorString(context: CommandContext): String

Return a translated, formatted error string.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

getValue

operator fun getValue(thisRef: Arguments, property: KProperty<*>): Message

For delegation, retrieve the parsed value if it's been set, or null if it hasn't.

handleError

open suspend fun handleError(t: Throwable, context: CommandContext): Key

Given a Throwable encountered during the parse function, return a human-readable string to display on Discord.

mutate

open suspend fun mutate(context: CommandContext): Message

Call the mutator lambda, if one was provided.

parse

open suspend override fun parse(parser: StringParser?, context: CommandContext, named: String?): Boolean

Process the string in the given parser, converting it into a new value.

parseOption

open suspend override fun parseOption(context: CommandContext, option: OptionValue<*>): Boolean

Use the given option taken straight from the slash command invocation to fill the converter.

toDefaulting

open fun toDefaulting(defaultValue: Message, outputError: Boolean = false, signatureType: Key? = null, showTypeInSignature: Boolean? = null, errorType: Key? = null, nestedValidator: Validator<Message> = null): DefaultingConverter<Message>

Wrap this single converter with a SingleToDefaultingConverter, which is a special converter that will act like a DefaultingConverter using the same logic of this converter.

toList

open fun toList(required: Boolean = true, signatureType: Key? = null, showTypeInSignature: Boolean? = null, errorType: Key? = null, nestedValidator: Validator<List<Message>> = null): ListConverter<Message>

Wrap this single converter with a SingleToListConverter, which is a special converter that will act like a ListConverter using the same logic of this converter.

toOptional

open fun toOptional(signatureType: Key? = null, showTypeInSignature: Boolean? = null, errorType: Key? = null, outputError: Boolean = false, nestedValidator: Validator<Message?> = null): OptionalConverter<Message>

Wrap this single converter with a SingleToOptionalConverter, which is a special converter that will act like an OptionalConverter using the same logic of this converter.

toSlashOption

open suspend override fun toSlashOption(arg: Argument<*>): OptionWrapper<StringChoiceBuilder>

validate

open suspend fun validate(context: CommandContext)

Call the validator lambda, if one was provided.