diskord-core/com.jessecorbett.diskord.api.interaction.command/CommandOption

CommandOption

@Serializable

Raw data option, to be converted

https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-type

Highly recommended to convert to and from CommandOption.Type using CommandOption.parsed and CommandOption.fromOption

Types

AttachmentOption

@Serializable

data class AttachmentOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val required: Boolean = false) : CommandOption.Type

BooleanOption

@Serializable

data class BooleanOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val required: Boolean = false) : CommandOption.Type

ChannelOption

@Serializable

data class ChannelOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val required: Boolean = false) : CommandOption.Type

CommandOptionChoice

@Serializable

data class CommandOptionChoice(val name: String, val value: JsonPrimitive, val localizedNames: Map<String, String> = emptyMap())

Companion

object Companion

IntegerOption

@Serializable

data class IntegerOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val required: Boolean = false, val choices: List<CommandOption.CommandOptionChoice> = emptyList(), val autocomplete: Boolean = false, val minValue: Int? = null, val maxValue: Int? = null) : CommandOption.Type

MentionableOption

@Serializable

data class MentionableOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val required: Boolean = false) : CommandOption.Type

NumberOption

@Serializable

data class NumberOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val required: Boolean = false, val choices: List<CommandOption.CommandOptionChoice> = emptyList(), val autocomplete: Boolean = false, val minValue: Float? = null, val maxValue: Float? = null) : CommandOption.Type

RoleOption

@Serializable

data class RoleOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val required: Boolean = false) : CommandOption.Type

StringOption

@Serializable

data class StringOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val required: Boolean = false, val choices: List<CommandOption.CommandOptionChoice> = emptyList(), val autocomplete: Boolean = false) : CommandOption.Type

SubCommandGroupOption

@Serializable

data class SubCommandGroupOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val options: List<CommandOption> = emptyList()) : CommandOption.Type

SubCommandOption

@Serializable

data class SubCommandOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val options: List<CommandOption> = emptyList()) : CommandOption.Type

Type

interface Type

UnknownOption

@Serializable

data class UnknownOption(val type: Int, val data: CommandOption) : CommandOption.Type

A representation of an option with a code we don't recognize

UserOption

@Serializable

data class UserOption(val name: String, val description: String, val localizedNames: Map<String, String> = emptyMap(), val localizedDescriptions: Map<String, String> = emptyMap(), val required: Boolean = false) : CommandOption.Type