revxrsal.commands.jda.actor

Interface SlashCommandActor

All Superinterfaces:

revxrsal.commands.command.CommandActor

public interface SlashCommandActor
extends revxrsal.commands.command.CommandActor

Represents a CommandActor that originated from a slash command, or from an auto-complete request.

Method Summary

Modifier and Type	Method and Description
default @NotNull net.dv8tion.jda.api.events.interaction.command.CommandAutoCompleteInteractionEvent	autoCompleteEvent() Returns this event as a CommandAutoCompleteInteractionEvent if it is from a slash command, otherwise throws a IllegalArgumentException.
default @Nullable net.dv8tion.jda.api.events.interaction.command.CommandAutoCompleteInteractionEvent	autoCompleteEventOrNull() Returns this event as a CommandAutoCompleteInteractionEvent if it is from an auto-complete events, otherwise returns null.
default @NotNull net.dv8tion.jda.api.entities.channel.middleman.MessageChannel	channel() Returns the MessageChannel that this interaction ocurred in
default @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent	commandEvent() Returns this event as a SlashCommandInteractionEvent if it is from a slash command, otherwise throws a IllegalArgumentException.
default @Nullable net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent	commandEventOrNull() Returns this event as a SlashCommandInteractionEvent if it is from a slash command, otherwise returns null.
default net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction	deferReply() Acknowledge this interaction and defer the reply to a later time.
default net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction	deferReply(boolean ephemeral) Acknowledge this interaction and defer the reply to a later time.
@NotNull net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent	event() Returns the underlying event
default @NotNull net.dv8tion.jda.api.entities.Guild	guild() Returns the guild the command was executed in, otherwise throws a GuildOnlyCommandException
default @Nullable net.dv8tion.jda.api.entities.Guild	guildOrNull() Returns the guild the command was executed in, otherwise returns null
default @NotNull net.dv8tion.jda.api.interactions.InteractionHook	hook() The InteractionHook which can be used to send deferred replies or followup messages.
default @NotNull net.dv8tion.jda.api.JDA	jda() Returns the JDA instance
revxrsal.commands.Lamp<SlashCommandActor>	lamp() Returns the Lamp instance that constructed this actor.
default net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction	replyToInteraction(@NotNull net.dv8tion.jda.api.utils.messages.MessageCreateData content) Reply to this interaction and acknowledge it.
default net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction	replyToInteraction(@NotNull java.lang.String content) Reply to this interaction and acknowledge it.
default @NotNull net.dv8tion.jda.api.entities.SelfUser	selfUser() Returns the currently logged-in user
@NotNull net.dv8tion.jda.api.entities.User	user() Returns the underlying User

Methods inherited from interface revxrsal.commands.command.CommandActor

error, name, reply, sendRawError, sendRawMessage, uniqueId

Method Detail

user

@NotNull
@NotNull net.dv8tion.jda.api.entities.User user()

Returns the underlying User

Returns:

The underlying User

event

@NotNull
@NotNull net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent event()

Returns the underlying event

Returns:

The underlying event

jda

@NotNull
default @NotNull net.dv8tion.jda.api.JDA jda()

Returns the JDA instance

Returns:

The JDA instance

selfUser

@NotNull
default @NotNull net.dv8tion.jda.api.entities.SelfUser selfUser()

Returns the currently logged-in user

Returns:

The currently logged-in user

See Also:

SelfUser

guildOrNull

@Nullable
default @Nullable net.dv8tion.jda.api.entities.Guild guildOrNull()

Returns the guild the command was executed in, otherwise returns null

Returns:

The guild, or null if not in a guild.

guild

@NotNull
default @NotNull net.dv8tion.jda.api.entities.Guild guild()

Returns the guild the command was executed in, otherwise throws a GuildOnlyCommandException

Returns:

The guild

Throws:

GuildOnlyCommandException - if not in a guild

channel

@NotNull
default @NotNull net.dv8tion.jda.api.entities.channel.middleman.MessageChannel channel()

Returns the MessageChannel that this interaction ocurred in

Returns:

The channel

commandEvent

@NotNull
default @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent commandEvent()

Returns this event as a SlashCommandInteractionEvent if it is from a slash command, otherwise throws a IllegalArgumentException.

Returns:

The event as a SlashCommandInteractionEvent

Throws:

java.lang.IllegalArgumentException - if it is not a SlashCommandInteractionEvent

commandEventOrNull

@Nullable
default @Nullable net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent commandEventOrNull()

Returns this event as a SlashCommandInteractionEvent if it is from a slash command, otherwise returns null.

Returns:

The event as a SlashCommandInteractionEvent, or null.

autoCompleteEvent

@NotNull
default @NotNull net.dv8tion.jda.api.events.interaction.command.CommandAutoCompleteInteractionEvent autoCompleteEvent()

Returns this event as a CommandAutoCompleteInteractionEvent if it is from a slash command, otherwise throws a IllegalArgumentException.

Returns:

The event as a CommandAutoCompleteInteractionEvent

Throws:

java.lang.IllegalArgumentException - if it is not a CommandAutoCompleteInteractionEvent

autoCompleteEventOrNull

@Nullable
default @Nullable net.dv8tion.jda.api.events.interaction.command.CommandAutoCompleteInteractionEvent autoCompleteEventOrNull()

Returns this event as a CommandAutoCompleteInteractionEvent if it is from an auto-complete events, otherwise returns null.

Returns:

The event as a CommandAutoCompleteInteractionEvent, or null.

replyToInteraction

@CheckReturnValue
 @Contract(pure=true)
default net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction replyToInteraction(@NotNull
                                                                                                                                            @NotNull java.lang.String content)

Reply to this interaction and acknowledge it.

Parameters:

content - The message content to send

Returns:

ReplyCallbackAction

See Also:

IReplyCallback.reply(String)

replyToInteraction

@CheckReturnValue
 @Contract(pure=true)
default net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction replyToInteraction(@NotNull
                                                                                                                                            @NotNull net.dv8tion.jda.api.utils.messages.MessageCreateData content)

Reply to this interaction and acknowledge it.

Parameters:

content - The message content to send

Returns:

ReplyCallbackAction

See Also:

IReplyCallback.reply(String)

deferReply

@CheckReturnValue
 @Contract(pure=true)
default net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction deferReply(boolean ephemeral)

Acknowledge this interaction and defer the reply to a later time.
This will send a <Bot> is thinking... message in chat that will be updated later through either InteractionHook.editOriginal(String) or WebhookClient.sendMessage(String).

Parameters:

ephemeral - True, if this message should only be visible to the interaction user

Returns:

ReplyCallbackAction

See Also:

IReplyCallback.deferReply(boolean)

deferReply

@CheckReturnValue
 @Contract(pure=true)
default net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction deferReply()

Acknowledge this interaction and defer the reply to a later time.
This will send a <Bot> is thinking... message in chat that will be updated later through either InteractionHook.editOriginal(String) or WebhookClient.sendMessage(String).

Returns:

ReplyCallbackAction

See Also:

IReplyCallback.deferReply()

hook

@CheckReturnValue
 @Contract(pure=true)
 @NotNull
default @NotNull net.dv8tion.jda.api.interactions.InteractionHook hook()

The InteractionHook which can be used to send deferred replies or followup messages.

Returns:

The interaction hook

lamp

revxrsal.commands.Lamp<SlashCommandActor> lamp()

Returns the Lamp instance that constructed this actor.

Specified by:

lamp in interface revxrsal.commands.command.CommandActor

Returns:

The lamp instance