BotCommands/io.github.freya022.botcommands.api.commands.application.context.user.options/UserContextCommandParameter

UserContextCommandParameter

interface UserContextCommandParameter : ContextCommandParameter(source)

Represents a user context command parameter, which has its value computed by an aggregation function, from one or more options.

Properties

Link copied to clipboard
open val allOptions: List<Option>

Options from this parameter and also nested aggregated parameters.

Link copied to clipboard
abstract override val command: UserCommandInfo

The executable command this parameter is from.

Link copied to clipboard
abstract val context: BContext

The main context.

Link copied to clipboard
abstract val index: Int

The index at which the parameter is, starts at 1 (#0 is the instance parameter).

Link copied to clipboard
abstract val isNullable: Boolean

Whether this parameter's value can be omitted.

Link copied to clipboard
open val isNullableOrOptional: Boolean

Whether this parameter's value can either be omitted or null

Link copied to clipboard
abstract val isOptional: Boolean

Whether this parameter's value can be null.

Link copied to clipboard
abstract val isVararg: Boolean

Whether this parameter is computed by an aggregator collecting an undefined amount parameters.

Link copied to clipboard
abstract val kParameter: KParameter

The parameter of the function.

Link copied to clipboard
abstract val name: String

Name of the parameter.

Link copied to clipboard
abstract override val nestedAggregatedParameters: List<UserContextCommandParameter>

Aggregations that this parameter also depends on.

Link copied to clipboard
abstract val options: List<Option>

Options consumed by this parameter's aggregator.

Link copied to clipboard
abstract val type: KType

Generified type of the parameter.

Functions

Link copied to clipboard
open fun getNestedOptionByDeclaredName(name: String): Option?

Returns the option with the supplied declared name (i.e., name of the method parameter), or null if not found.

Link copied to clipboard
open fun getOptionByDeclaredName(name: String): Option?

Returns the option with the supplied declared name (i.e., name of the method parameter), or null if not found.