kord-rest/dev.kord.rest.builder.interaction/NumericOptionBuilder

NumericOptionBuilder

sealed class NumericOptionBuilder<T : Number> : BaseChoiceBuilder<T> (source)

Builder for numeric options.

Inheritors

IntegerOptionBuilder

NumberOptionBuilder

Functions

choice

abstract fun choice(name: String, value: T, nameLocalizations: Optional<Map<Locale, String>?> = Optional.Missing())

inline fun choice(name: String, value: T, localizationsBuilder: ChoiceLocalizationsBuilder.() -> Unit)

Registers a new choice with name representing value and applies localizationsBuilder to it

description

open fun description(locale: Locale, description: String)

Registers a localization of description in locale.

name

open fun name(locale: Locale, name: String)

Registers a localization of name in locale.

toRequest

open override fun toRequest(): ApplicationCommandOption

Properties

autocomplete

var autocomplete: Boolean?

Setting this to true allows you to dynamically respond with your choices, depending on the user input.

choices

var choices: MutableList<Choice<*>>?

default

var default: Boolean?

description

open override var description: String

The default description.

descriptionLocalizations

open override var descriptionLocalizations: MutableMap<Locale, String>?

A MutableMap containing localized versions of description.

maxValue

var maxValue: T?

The maximum value permitted.

minValue

var minValue: T?

The minimum value permitted.

name

open override var name: String

The default name.

nameLocalizations

open override var nameLocalizations: MutableMap<Locale, String>?

A MutableMap containing localized versions of name.

required

var required: Boolean?

type

val type: ApplicationCommandOptionType