kord-core/dev.kord.core.entity.interaction

Package-level declarations

Types

ActionInteraction

sealed interface ActionInteraction : Interaction, ActionInteractionBehavior

An Interaction created when a user performs some form of action (e.g. using a slash command or pressing a button).

ApplicationCommandInteraction

sealed interface ApplicationCommandInteraction : ActionInteraction, ApplicationCommandInteractionBehavior

An ActionInteraction created when a user uses an ApplicationCommand.

AttachmentOptionValue

class AttachmentOptionValue(val value: Snowflake, val focused: Boolean, val resolvedObject: Attachment?) : ResolvableOptionValue<Attachment>

AutoCompleteInteraction

sealed interface AutoCompleteInteraction : DataInteraction, AutoCompleteInteractionBehavior

A DataInteraction indicating an auto-complete request from Discord.

BooleanOptionValue

class BooleanOptionValue(val value: Boolean, val focused: Boolean) : OptionValue<Boolean>

ButtonInteraction

sealed interface ButtonInteraction : ComponentInteraction

A ComponentInteraction created when a user presses a button.

ChannelOptionValue

class ChannelOptionValue(val value: Snowflake, val focused: Boolean, val resolvedObject: ResolvedChannel?) : ResolvableOptionValue<ResolvedChannel>

ChatInputCommandInteraction

sealed interface ChatInputCommandInteraction : ApplicationCommandInteraction

An ApplicationCommandInteraction created when a user uses a ChatInputCommandCommand.

ComponentInteraction

sealed interface ComponentInteraction : ActionInteraction, ComponentInteractionBehavior, ModalParentInteractionBehavior

An ActionInteraction created when a user interacts with a Component.

DataInteraction

sealed interface DataInteraction : Interaction, DataInteractionBehavior

An Interaction created when Discord requests some form of data (e.g. for auto-complete).

GlobalApplicationCommandInteraction

sealed interface GlobalApplicationCommandInteraction : ApplicationCommandInteraction, GlobalInteraction

An ApplicationCommandInteraction that took place in a global context (e.g. a DM).

GlobalAutoCompleteInteraction

class GlobalAutoCompleteInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : AutoCompleteInteraction, GlobalInteraction

An AutoCompleteInteraction that took place in a global context (e.g. a DM).

GlobalButtonInteraction

class GlobalButtonInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : ButtonInteraction, GlobalComponentInteraction

A ButtonInteraction that took place in a global context (e.g. a DM).

GlobalChatInputCommandInteraction

class GlobalChatInputCommandInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : ChatInputCommandInteraction, GlobalApplicationCommandInteraction

A ChatInputCommandInteraction that took place in a global context (e.g. a DM).

GlobalComponentInteraction

sealed interface GlobalComponentInteraction : ComponentInteraction, GlobalInteraction

A ComponentInteraction that took place in a global context (e.g. a DM).

GlobalInteraction

sealed interface GlobalInteraction : Interaction, GlobalInteractionBehavior

An Interaction that took place in a global context (e.g. a DM).

GlobalMessageCommandInteraction

class GlobalMessageCommandInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : MessageCommandInteraction, GlobalApplicationCommandInteraction

A MessageCommandInteraction that took place in a global context (e.g. a DM).

GlobalModalSubmitInteraction

class GlobalModalSubmitInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : ModalSubmitInteraction, GlobalInteraction

A ModalSubmitInteraction that took place in a global context (e.g. a DM).

GlobalSelectMenuInteraction

class GlobalSelectMenuInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : SelectMenuInteraction, GlobalComponentInteraction

A SelectMenuInteraction that took place in a global context (e.g. a DM).

GlobalUserCommandInteraction

class GlobalUserCommandInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : UserCommandInteraction, GlobalApplicationCommandInteraction

A GlobalUserCommandInteraction that took place in a global context (e.g. a DM).

GroupCommand

class GroupCommand(val data: ApplicationInteractionData, val kord: Kord) : InteractionCommand

Represents an invocation of a sub-command under a group under the root command.

GuildApplicationCommandInteraction

sealed interface GuildApplicationCommandInteraction : ApplicationCommandInteraction, GuildInteraction

An ApplicationCommandInteraction that took place in the context of a Guild.

GuildAutoCompleteInteraction

class GuildAutoCompleteInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : AutoCompleteInteraction, GuildInteraction

An AutoCompleteInteraction that took place in the context of a Guild.

GuildButtonInteraction

class GuildButtonInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : ButtonInteraction, GuildComponentInteraction

A ButtonInteraction that took place in the context of a Guild.

GuildChatInputCommandInteraction

class GuildChatInputCommandInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : ChatInputCommandInteraction, GuildApplicationCommandInteraction

A ChatInputCommandInteraction that took place in the context of a Guild.

GuildComponentInteraction

sealed interface GuildComponentInteraction : ComponentInteraction, GuildInteraction

A ComponentInteraction that took place in the context of a Guild.

GuildInteraction

sealed interface GuildInteraction : Interaction, GuildInteractionBehavior

An Interaction that took place in the context of a Guild.

GuildMessageCommandInteraction

class GuildMessageCommandInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : MessageCommandInteraction, GuildApplicationCommandInteraction

A MessageCommandInteraction that took place in the context of a Guild.

GuildModalSubmitInteraction

class GuildModalSubmitInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : ModalSubmitInteraction, GuildInteraction

A ModalSubmitInteraction that took place in the context of a Guild.

GuildSelectMenuInteraction

class GuildSelectMenuInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : SelectMenuInteraction, GuildComponentInteraction

A SelectMenuInteraction that took place in the context of a Guild.

GuildUserCommandInteraction

class GuildUserCommandInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier) : UserCommandInteraction, GuildApplicationCommandInteraction

A UserCommandInteraction that took place in the context of a Guild.

IntegerOptionValue

class IntegerOptionValue(val value: Long, val focused: Boolean) : OptionValue<Long>

Interaction

sealed interface Interaction : InteractionBehavior

An instance of an interaction.

InteractionCommand

sealed interface InteractionCommand : KordObject

The base interface of all commands that can be executed under a ChatInputCommandInteraction.

MemberOptionValue

class MemberOptionValue(val value: Snowflake, val focused: Boolean, val resolvedObject: Member?) : UserOptionValue

MentionableOptionValue

class MentionableOptionValue(val value: Snowflake, val focused: Boolean, val resolvedObject: Entity?) : ResolvableOptionValue<Entity>

MessageCommandInteraction

sealed interface MessageCommandInteraction : ApplicationCommandInteraction

An ApplicationCommandInteraction created when a user uses a MessageCommand.

ModalSubmitInteraction

sealed interface ModalSubmitInteraction : ActionInteraction, ComponentInteractionBehavior

An ActionInteraction created when a user submits a modal.

NumberOptionValue

class NumberOptionValue(val value: Double, val focused: Boolean) : OptionValue<Double>

OptionValue

sealed interface OptionValue<out T>

ResolvableOptionValue

sealed interface ResolvableOptionValue<out T : Entity> : OptionValue<Snowflake>

ResolvedObjects

class ResolvedObjects(val data: ResolvedObjectsData, val kord: Kord, val strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy)

RoleOptionValue

class RoleOptionValue(val value: Snowflake, val focused: Boolean, val resolvedObject: Role?) : ResolvableOptionValue<Role>

RootCommand

class RootCommand(val data: ApplicationInteractionData, val kord: Kord) : InteractionCommand

Represents an invocation of a root command.

SelectMenuInteraction

sealed interface SelectMenuInteraction : ComponentInteraction

A ComponentInteraction created when a user interacts with a select menu.

StringOptionValue

class StringOptionValue(val value: String, val focused: Boolean) : OptionValue<String>

SubCommand

class SubCommand(val data: ApplicationInteractionData, val kord: Kord) : InteractionCommand

Represents an invocation of a sub-command under the root command.

UserCommandInteraction

sealed interface UserCommandInteraction : ApplicationCommandInteraction

An ApplicationCommandInteraction created when a user uses a UserCommand.

UserOptionValue

open class UserOptionValue(val value: Snowflake, val focused: Boolean, val resolvedObject: User?) : ResolvableOptionValue<User>

Functions

ComponentInteraction

fun ComponentInteraction(data: InteractionData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier): ComponentInteraction

Creates a ComponentInteraction with the given data, kord and supplier.

GlobalApplicationCommandInteraction

fun GlobalApplicationCommandInteraction(data: InteractionData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier): GlobalApplicationCommandInteraction

GuildApplicationCommandInteraction

fun GuildApplicationCommandInteraction(data: InteractionData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier): GuildApplicationCommandInteraction

InteractionCommand

fun InteractionCommand(data: ApplicationInteractionData, kord: Kord): InteractionCommand

ModalSubmitInteraction

fun ModalSubmitInteraction(data: InteractionData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier): ModalSubmitInteraction

OptionValue

fun OptionValue(value: CommandArgument<*>, resolvedObjects: ResolvedObjects?): OptionValue<*>