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

ChannelConverter

class ChannelConverter(requireSameGuild: Boolean = true, requiredGuild: suspend () -> Snowflake? = null, requiredChannelTypes: Set<ChannelType> = setOf(), var validator: Validator<Channel> = null) : SingleConverter<Channel>

Argument converter for Discord Channel arguments.

This converter supports specifying channels by supplying:

A channel mention
A channel ID, with or without a # prefix
A channel name, with or without a # prefix (the required guild will be searched for the first matching channel)
this to refer to the current channel

Parameters

requireSameGuild

Whether to require that the channel passed is on the same guild as the message.

requiredGuild

Lambda returning a specific guild to require the channel to be in, if needed.

Constructors

ChannelConverter

constructor(requireSameGuild: Boolean = true, requiredGuild: suspend () -> Snowflake? = null, requiredChannelTypes: Set<ChannelType> = setOf(), validator: Validator<Channel> = 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<Channel>

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: Channel

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<Channel>

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

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): Channel

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: Channel, outputError: Boolean = false, signatureType: Key? = null, showTypeInSignature: Boolean? = null, errorType: Key? = null, nestedValidator: Validator<Channel> = null): DefaultingConverter<Channel>

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<Channel>> = null): ListConverter<Channel>

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<Channel?> = null): OptionalConverter<Channel>

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<ChannelBuilder>

validate

open suspend fun validate(context: CommandContext)

Call the validator lambda, if one was provided.