application-commands/io.facet.commands

Package io.facet.commands

Types

ApplicationCommand

interface ApplicationCommand<in C : ApplicationCommandContext>

A discord application command.

ApplicationCommandBuilder

open class ApplicationCommandBuilder

ApplicationCommandContext

sealed class ApplicationCommandContext : CoroutineScope

The context for an interaction with an application command.

GlobalApplicationCommand

interface GlobalApplicationCommand<in C : ApplicationCommandContext, GlobalCommandContext> : ApplicationCommand<C>

GlobalCommandContext

interface GlobalCommandContext

GlobalGuildApplicationCommand

interface GlobalGuildApplicationCommand<in C : ApplicationCommandContext, GuildCommandContext> : ApplicationCommand<C>

GlobalGuildMessageCommand

interface GlobalGuildMessageCommand : MessageCommand<GuildMessageCommandContext> , GlobalGuildApplicationCommand<GuildMessageCommandContext>

An application command that is available globally, but can only be used from within a guild.

GlobalGuildSlashCommand

interface GlobalGuildSlashCommand : SlashCommand<GuildSlashCommandContext> , GlobalGuildApplicationCommand<GuildSlashCommandContext>

An application command that is available globally, but can only be used from within a guild.

GlobalGuildUserCommand

interface GlobalGuildUserCommand : UserCommand<GuildUserCommandContext> , GlobalGuildApplicationCommand<GuildUserCommandContext>

An application command that is available globally, but can only be used from within a guild.

GlobalMessageCommand

interface GlobalMessageCommand : MessageCommand<GlobalMessageCommandContext> , GlobalApplicationCommand<GlobalMessageCommandContext>

An application command that is available globally.

GlobalMessageCommandContext

class GlobalMessageCommandContext(event: MessageInteractionEvent, scope: CoroutineScope) : MessageCommandContext, GlobalCommandContext

The context for an interaction with an ApplicationCommand that could have been used in a DM.

GlobalSlashCommand

interface GlobalSlashCommand : SlashCommand<GlobalSlashCommandContext> , GlobalApplicationCommand<GlobalSlashCommandContext>

An application command that is available globally.

GlobalSlashCommandContext

class GlobalSlashCommandContext(event: ChatInputInteractionEvent, scope: CoroutineScope) : SlashCommandContext, GlobalCommandContext

The context for an interaction with an ApplicationCommand that could have been used in a DM.

GlobalUserCommand

interface GlobalUserCommand : UserCommand<GlobalUserCommandContext> , GlobalApplicationCommand<GlobalUserCommandContext>

An application command that is available globally.

GlobalUserCommandContext

class GlobalUserCommandContext(event: UserInteractionEvent, scope: CoroutineScope) : UserCommandContext, GlobalCommandContext

The context for an interaction with an ApplicationCommand that could have been used in a DM.

GuildApplicationCommand

interface GuildApplicationCommand<in C : ApplicationCommandContext, GuildCommandContext> : ApplicationCommand<C>

GuildCommandContext

interface GuildCommandContext

GuildMessageCommand

interface GuildMessageCommand : MessageCommand<GuildMessageCommandContext> , GuildApplicationCommand<GuildMessageCommandContext>

An application command that is only available within a specific guild.

GuildMessageCommandContext

class GuildMessageCommandContext(event: MessageInteractionEvent, scope: CoroutineScope) : MessageCommandContext, GuildCommandContext

The context for an interaction with an ApplicationCommand that occurred in a server.

GuildSlashCommand

interface GuildSlashCommand : SlashCommand<GuildSlashCommandContext> , GuildApplicationCommand<GuildSlashCommandContext>

An application command that is only available within a specific guild.

GuildSlashCommandContext

class GuildSlashCommandContext(event: ChatInputInteractionEvent, scope: CoroutineScope) : SlashCommandContext, GuildCommandContext

The context for an interaction with an ApplicationCommand that occurred in a server.

GuildUserCommand

interface GuildUserCommand : UserCommand<GuildUserCommandContext> , GuildApplicationCommand<GuildUserCommandContext>

An application command that is only available within a specific guild.

GuildUserCommandContext

class GuildUserCommandContext(event: UserInteractionEvent, scope: CoroutineScope) : UserCommandContext, GuildCommandContext

The context for an interaction with an ApplicationCommand that occurred in a server.

InteractionOptions

class InteractionOptions(commandInteraction: ApplicationCommandInteraction)

An experimental class for getting command options through property delegation.

MessageCommand

interface MessageCommand<in C : MessageCommandContext> : ApplicationCommand<C>

MessageCommandContext

sealed class MessageCommandContext : ApplicationCommandContext

OptionBuilder

class OptionBuilder : ApplicationCommandBuilder

PermissibleApplicationCommand

interface PermissibleApplicationCommand

A command that is restricted using the implemented hasPermission function.

SlashCommand

interface SlashCommand<in C : SlashCommandContext> : ApplicationCommand<C>

SlashCommandContext

sealed class SlashCommandContext : ApplicationCommandContext

UserCommand

interface UserCommand<in C : UserCommandContext> : ApplicationCommand<C>

UserCommandContext

sealed class UserCommandContext : ApplicationCommandContext

Functions

acknowledge

~~suspend~~ ~~fun~~ ApplicationCommandContext.~~acknowledge~~(~~ephemeral~~: Boolean = ~~false~~)

Acknowledges the interaction indicating a response will be edited later. The user sees a loading state, visible to all participants in the invoking channel. For a "only you can see this" response, set ephemeral to true, or use acknowledgeEphemeral().

acknowledgeEphemeral

~~suspend~~ ~~fun~~ ApplicationCommandContext.~~acknowledgeEphemeral~~()

Acknowledges the interaction indicating a response will be edited later. Only the invoking user sees a loading state.

applicationCommandRequest

fun MessageCommand<*>.applicationCommandRequest(name: String): ApplicationCommandRequest

DSL for building ApplicationCommandRequest for message commands

fun UserCommand<*>.applicationCommandRequest(name: String): ApplicationCommandRequest

DSL for building ApplicationCommandRequest for user commands

fun applicationCommandRequest(name: String, desc: String, block: ApplicationCommandBuilder.() -> Unit = {}): ApplicationCommandRequest

fun SlashCommand<*>.applicationCommandRequest(name: String, desc: String, block: ApplicationCommandBuilder.() -> Unit = {}): ApplicationCommandRequest

DSL for building ApplicationCommandRequest for slash commands

deferReply

suspend fun ApplicationCommandContext.deferReply(ephemeral: Boolean = false)

Acknowledges the interaction indicating a response will be edited later. The user sees a loading state, visible to all participants in the invoking channel. For a "only you can see this" response, set ephemeral to true.