Package net.dv8tion.jda.api.interactions

Interface Interaction

All Superinterfaces:

ISnowflake

All Known Subinterfaces:

ButtonInteraction, CommandInteraction, ComponentInteraction, SelectionMenuInteraction

All Known Implementing Classes:

ButtonClickEvent, GenericComponentInteractionCreateEvent, GenericInteractionCreateEvent, SelectionMenuEvent, SlashCommandEvent

public interface Interaction
extends ISnowflake

Abstract representation for any kind of Discord interaction.
This includes things such as Slash-Commands or Buttons.

To properly handle an interaction you must acknowledge it. This means you need to use either reply(String), deferReply(), or another similar method for other interactions.

Once the interaction is acknowledged, you can use getHook() to send additional messages or update the original reply. When using deferReply() the first message sent to the InteractionHook will be identical to using InteractionHook.editOriginal(String). You must decide whether your reply will be ephemeral or not before calling deferReply(). So design your code flow with that in mind!

You can only acknowledge an interaction once! Any additional calls to reply/deferReply will result in exceptions. You can use isAcknowledged() to check whether the interaction has been acknowledged already.

Method Summary

Modifier and Type	Method	Description
ReplyAction	deferReply()	Acknowledge this interaction and defer the reply to a later time.
default ReplyAction	deferReply(boolean ephemeral)	Acknowledge this interaction and defer the reply to a later time.
Channel	getChannel()	The channel this interaction happened in.
default ChannelType	getChannelType()	The ChannelType for the channel this interaction came from.
Guild	getGuild()	The Guild this interaction happened in.
default GuildChannel	getGuildChannel()	The GuildChannel this interaction happened in.
InteractionHook	getHook()	The InteractionHook which can be used to send deferred replies or followup messages.
JDA	getJDA()	Returns the JDA instance of this interaction
Member	getMember()	The Member who caused this interaction.
default MessageChannel	getMessageChannel()	The MessageChannel this interaction happened in.
default NewsChannel	getNewsChannel()	The NewsChannel this interaction happened in.
default PrivateChannel	getPrivateChannel()	The PrivateChannel this interaction happened in.
default TextChannel	getTextChannel()	The TextChannel this interaction happened in.
String	getToken()	The interaction token used for responding to an interaction.
default InteractionType	getType()	The InteractionType for this interaction.
int	getTypeRaw()	The raw interaction type.
User	getUser()	The User who caused this interaction.
default VoiceChannel	getVoiceChannel()	The VoiceChannel this interaction happened in.
boolean	isAcknowledged()	Whether this interaction has already been acknowledged.
default boolean	isFromGuild()	Whether this interaction came from a Guild.
default ReplyAction	reply(String content)	Reply to this interaction and acknowledge it.
default ReplyAction	reply(Message message)	Reply to this interaction and acknowledge it.
default ReplyAction	replyEmbeds(Collection<? extends MessageEmbed> embeds)	Reply to this interaction and acknowledge it.
default ReplyAction	replyEmbeds(MessageEmbed embed, MessageEmbed... embeds)	Reply to this interaction and acknowledge it.
default ReplyAction	replyFormat(String format, Object... args)	Reply to this interaction and acknowledge it.

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Method Detail

getTypeRaw

int getTypeRaw()

The raw interaction type.
It is recommended to use getType() instead.

Returns:

The raw interaction type

getType

@Nonnull
default InteractionType getType()

The InteractionType for this interaction.

Returns:

The InteractionType or InteractionType.UNKNOWN

getToken

@Nonnull
String getToken()

The interaction token used for responding to an interaction.

Returns:

The interaction token

getGuild

@Nullable
Guild getGuild()

The Guild this interaction happened in.
This is null in direct messages.

Returns:

The Guild or null

isFromGuild

default boolean isFromGuild()

Whether this interaction came from a Guild.
This is identical to getGuild() != null

Returns:

True, if this interaction happened in a guild

getChannelType

@Nonnull
default ChannelType getChannelType()

The ChannelType for the channel this interaction came from.
If getChannel() is null, this returns ChannelType.UNKNOWN.

Returns:

The ChannelType

getUser

@Nonnull
User getUser()

The User who caused this interaction.

Returns:

The User

getMember

@Nullable
Member getMember()

The Member who caused this interaction.
This is null if the interaction is not from a guild.

Returns:

The Member

getChannel

@Nullable
Channel getChannel()

The channel this interaction happened in.
This is currently never null, but might be nullable in the future.

Returns:

The channel or null if this interaction is not from a channel context

getHook

@Nonnull
InteractionHook getHook()

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

Returns:

The interaction hook

Throws:

UnsupportedOperationException - If this interaction does not support deferred replies and followup messages

isAcknowledged

boolean isAcknowledged()

Whether this interaction has already been acknowledged.
Both deferReply() and reply(String) acknowledge an interaction. Each interaction can only be acknowledged once.

Returns:

True, if this interaction has already been acknowledged

deferReply

@Nonnull
@CheckReturnValue
ReplyAction 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).

You can use deferReply(true) to send a deferred ephemeral reply. If your initial deferred message is not ephemeral it cannot be made ephemeral later. Your first message to the InteractionHook will inherit whether the message is ephemeral or not from this deferred reply.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

Use reply(String) to reply directly.

Returns:

ReplyAction

deferReply

@Nonnull
@CheckReturnValue
default ReplyAction 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).

You can use deferReply() or deferReply(false) to send a non-ephemeral deferred reply. If your initial deferred message is ephemeral it cannot be made non-ephemeral later. Your first message to the InteractionHook will inherit whether the message is ephemeral or not from this deferred reply.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

Use reply(String) to reply directly.

Ephemeral messages have some limitations and will be removed once the user restarts their client.
When a message is ephemeral, it will only be visible to the user that used the interaction.
Limitations:

• Cannot be deleted by the bot
• Cannot contain any files/attachments
• Cannot be reacted to
• Cannot be retrieved

Parameters:

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

Returns:

ReplyAction

reply

@Nonnull
@CheckReturnValue
default ReplyAction reply(@Nonnull
                          Message message)

Reply to this interaction and acknowledge it.
This will send a reply message for this interaction. You can use setEphemeral(true) to only let the target user see the message. Replies are non-ephemeral by default.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

If your handling can take longer than 3 seconds, due to various rate limits or other conditions, you should use deferReply() instead.

Parameters:

message - The message to send

Returns:

ReplyAction

Throws:

IllegalArgumentException - If null is provided

reply

@Nonnull
@CheckReturnValue
default ReplyAction reply(@Nonnull
                          String content)

Reply to this interaction and acknowledge it.
This will send a reply message for this interaction. You can use setEphemeral(true) to only let the target user see the message. Replies are non-ephemeral by default.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

If your handling can take longer than 3 seconds, due to various rate limits or other conditions, you should use deferReply() instead.

Parameters:

content - The message content to send

Returns:

ReplyAction

Throws:

IllegalArgumentException - If null is provided or the content is empty or longer than Message.MAX_CONTENT_LENGTH

replyEmbeds

@Nonnull
@CheckReturnValue
default ReplyAction replyEmbeds(@Nonnull
                                Collection<? extends MessageEmbed> embeds)

Reply to this interaction and acknowledge it.
This will send a reply message for this interaction. You can use setEphemeral(true) to only let the target user see the message. Replies are non-ephemeral by default.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

If your handling can take longer than 3 seconds, due to various rate limits or other conditions, you should use deferReply() instead.

Parameters:

embeds - The MessageEmbeds to send

Returns:

ReplyAction

Throws:

IllegalArgumentException - If null is provided

replyEmbeds

@Nonnull
@CheckReturnValue
default ReplyAction replyEmbeds(@Nonnull
                                MessageEmbed embed,
                                @Nonnull
                                MessageEmbed... embeds)

Reply to this interaction and acknowledge it.
This will send a reply message for this interaction. You can use setEphemeral(true) to only let the target user see the message. Replies are non-ephemeral by default.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

If your handling can take longer than 3 seconds, due to various rate limits or other conditions, you should use deferReply() instead.

Parameters:

embed - The message embed to send

embeds - Any additional embeds to send

Returns:

ReplyAction

Throws:

IllegalArgumentException - If null is provided

replyFormat

@Nonnull
@CheckReturnValue
default ReplyAction replyFormat(@Nonnull
                                String format,
                                @Nonnull
                                Object... args)

Reply to this interaction and acknowledge it.
This will send a reply message for this interaction. You can use setEphemeral(true) to only let the target user see the message. Replies are non-ephemeral by default.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

If your handling can take longer than 3 seconds, due to various rate limits or other conditions, you should use deferReply() instead.

Parameters:

format - Format string for the message content

args - Format arguments for the content

Returns:

ReplyAction

Throws:

IllegalArgumentException - If the format string is null or the resulting content is longer than Message.MAX_CONTENT_LENGTH

getGuildChannel

@Nonnull
default GuildChannel getGuildChannel()

The GuildChannel this interaction happened in.
If getChannelType() is not a guild type, this throws IllegalStateException!

Returns:

The GuildChannel

Throws:

IllegalStateException - If getChannel() is not a guild channel

getMessageChannel

@Nonnull
default MessageChannel getMessageChannel()

The MessageChannel this interaction happened in.
If getChannelType() is not a message channel type, this throws IllegalStateException!

Returns:

The MessageChannel

Throws:

IllegalStateException - If getChannel() is not a message channel

getTextChannel

@Nonnull
default TextChannel getTextChannel()

The TextChannel this interaction happened in.
If getChannelType() is not ChannelType.TEXT, this throws IllegalStateException!

Returns:

The TextChannel

Throws:

IllegalStateException - If getChannel() is not a text channel

getNewsChannel

@Nonnull
default NewsChannel getNewsChannel()

The NewsChannel this interaction happened in.
If getChannelType() is not ChannelType.NEWS, this throws IllegalStateException!

Returns:

The NewsChannel

Throws:

IllegalStateException - If getChannel() is not a news channel

getVoiceChannel

@Nonnull
default VoiceChannel getVoiceChannel()

The VoiceChannel this interaction happened in.
If getChannelType() is not ChannelType.VOICE, this throws IllegalStateException!

Returns:

The VoiceChannel

Throws:

IllegalStateException - If getChannel() is not a voice channel

getPrivateChannel

@Nonnull
default PrivateChannel getPrivateChannel()

The PrivateChannel this interaction happened in.
If getChannelType() is not ChannelType.PRIVATE, this throws IllegalStateException!

Returns:

The PrivateChannel

Throws:

IllegalStateException - If getChannel() is not a private channel

getJDA

@Nonnull
JDA getJDA()

Returns the JDA instance of this interaction

Returns:

the corresponding JDA instance