BotCommands/io.github.freya022.botcommands.api.parameters

Package-level declarations

Types

interface AggregatedParameter : MethodParameter

Parameter which has its value computed by an aggregation function, from one or more options.

@InterfacedService(acceptMultiple = true)

abstract class ClassParameterResolver<T : ClassParameterResolver<T, R>, R : Any>(val jvmErasure: KClass<out R>) : ParameterResolver<T, R>

Base class for parameter resolvers using static types.

EnumNameFunction

fun interface EnumNameFunction<E : Enum<E>>

Transforms an enum entry into a human-readable name.

EnumResolverBuilder

class EnumResolverBuilder<E : Enum<E>>

EnumValuesSupplier

fun interface EnumValuesSupplier<E : Enum<E>>

Retrieves the enum entries to be pushed to the provided scope.

MethodParameter

interface MethodParameter

Parameter of an Executable.

ParameterResolver

@InterfacedService(acceptMultiple = true)

sealed class ParameterResolver<T : ParameterResolver<T, R>, R : Any> : IParameterResolver<T>

Base class for parameter resolvers used in text commands, application commands, and component callbacks.

ParameterResolverFactory

@InterfacedService(acceptMultiple = true)

abstract class ParameterResolverFactory<out T : IParameterResolver<T>>(val resolverType: KClass<out T>)

Factory for parameter resolvers.

ResolverData

interface ResolverData

Marker interface for data passed when requesting for a parameter resolver.

ResolverRequest

class ResolverRequest(val parameter: ParameterWrapper, val resolverData: ResolverData? = null)

Data used when retrieving a resolver factory.

Resolvers

object Resolvers

Utility factories to create commonly used parameter resolvers.

TypedParameterResolver

@InterfacedService(acceptMultiple = true)

abstract class TypedParameterResolver<T : TypedParameterResolver<T, R>, R : Any>(val type: KType) : ParameterResolver<T, R>

Base class for parameter resolvers using static types.

TypedParameterResolverFactory

abstract class TypedParameterResolverFactory<out T : IParameterResolver<T>>(resolverType: KClass<out T>, val type: KType) : ParameterResolverFactory<T>

Specialization of ParameterResolverFactory for a specific KType. Java users can supply a KotlinTypeToken instead.

Functions

enumResolver

inline fun <E : Enum<E>> enumResolver(guildValuesSupplier: EnumValuesSupplier<E>, noinline nameFunction: (e: E) -> String = { it.toHumanName() }, block: EnumResolverBuilder<E>.() -> Unit = {}): ClassParameterResolver<*, E>

inline fun <E : Enum<E>> enumResolver(vararg values: E = enumValues(), noinline nameFunction: (e: E) -> String = { it.toHumanName() }, block: EnumResolverBuilder<E>.() -> Unit = {}): ClassParameterResolver<*, E>

Creates an enum resolver for slash commands, as well as component data and timeout data.

resolverFactory

inline fun <T : ParameterResolver<T, R>, R : Any> resolverFactory(priority: Int = 0, crossinline producer: (request: ResolverRequest) -> T): ParameterResolverFactory<T>

Creates a parameter resolver factory from the provided resolver producer.

toHumanName

fun Enum<*>.toHumanName(locale: Locale = Locale.ROOT): String

Convert an enum to a more human-friendly name.