Class GenericInteractionCreateEvent
- java.lang.Object
-
- net.dv8tion.jda.api.events.Event
-
- net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent
-
- All Implemented Interfaces:
ISnowflake
,GenericEvent
,Interaction
- Direct Known Subclasses:
GenericAutoCompleteInteractionEvent
,GenericCommandInteractionEvent
,GenericComponentInteractionCreateEvent
public class GenericInteractionCreateEvent extends Event implements Interaction
Indicates that anInteraction
was created.
Every interaction event is derived from this event.Requirements
To receive these events, you must unset the Interactions Endpoint URL in your application dashboard. You can simply remove the URL for this endpoint in your settings at the Discord Developers Portal.- See Also:
Interaction
-
-
Constructor Summary
Constructors Constructor Description GenericInteractionCreateEvent(JDA api, long responseNumber, Interaction interaction)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Channel
getChannel()
The channel this interaction happened in.Guild
getGuild()
TheGuild
this interaction happened in.Locale
getGuildLocale()
Returns the preferred language of the Guild.long
getIdLong()
The Snowflake id of this entity.Interaction
getInteraction()
TheInteraction
instance.Member
getMember()
TheMember
who caused this interaction.String
getToken()
The interaction token used for responding to an interaction.int
getTypeRaw()
The raw interaction type.User
getUser()
TheUser
who caused this interaction.Locale
getUserLocale()
Returns the selected language of the invoking user.boolean
isAcknowledged()
Whether this interaction has already been acknowledged.-
Methods inherited from class net.dv8tion.jda.api.events.Event
getJDA, getResponseNumber
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.dv8tion.jda.api.interactions.Interaction
getChannelType, getGuildChannel, getJDA, getMessageChannel, getNewsChannel, getPrivateChannel, getTextChannel, getThreadChannel, getType, getVoiceChannel, isFromGuild
-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getTimeCreated
-
-
-
-
Constructor Detail
-
GenericInteractionCreateEvent
public GenericInteractionCreateEvent(@Nonnull JDA api, long responseNumber, @Nonnull Interaction interaction)
-
-
Method Detail
-
getInteraction
@Nonnull public Interaction getInteraction()
TheInteraction
instance.
Note that this event is a delegate which implements the same interface.- Returns:
- The
Interaction
-
getToken
@Nonnull public String getToken()
Description copied from interface:Interaction
The interaction token used for responding to an interaction.- Specified by:
getToken
in interfaceInteraction
- Returns:
- The interaction token
-
getTypeRaw
public int getTypeRaw()
Description copied from interface:Interaction
The raw interaction type.
It is recommended to useInteraction.getType()
instead.- Specified by:
getTypeRaw
in interfaceInteraction
- Returns:
- The raw interaction type
-
getGuild
@Nullable public Guild getGuild()
Description copied from interface:Interaction
TheGuild
this interaction happened in.
This is null in direct messages.- Specified by:
getGuild
in interfaceInteraction
- Returns:
- The
Guild
or null
-
getChannel
@Nullable public Channel getChannel()
Description copied from interface:Interaction
The channel this interaction happened in.
This is currently never null, but might be nullable in the future.- Specified by:
getChannel
in interfaceInteraction
- Returns:
- The channel or null if this interaction is not from a channel context
-
getUserLocale
@Nonnull public Locale getUserLocale()
Description copied from interface:Interaction
Returns the selected language of the invoking user.- Specified by:
getUserLocale
in interfaceInteraction
- Returns:
- The language of the invoking user
-
getGuildLocale
@Nonnull public Locale getGuildLocale()
Description copied from interface:Interaction
Returns the preferred language of the Guild.
This is identical togetGuild().getLocale()
.- Specified by:
getGuildLocale
in interfaceInteraction
- Returns:
- The preferred language of the Guild
-
getMember
@Nullable public Member getMember()
Description copied from interface:Interaction
TheMember
who caused this interaction.
This is null if the interaction is not from a guild.- Specified by:
getMember
in interfaceInteraction
- Returns:
- The
Member
-
getUser
@Nonnull public User getUser()
Description copied from interface:Interaction
TheUser
who caused this interaction.- Specified by:
getUser
in interfaceInteraction
- Returns:
- The
User
-
getIdLong
public long getIdLong()
Description copied from interface:ISnowflake
The Snowflake id of this entity. This is unique to every entity and will never change.- Specified by:
getIdLong
in interfaceISnowflake
- Returns:
- Long containing the Id.
-
isAcknowledged
public boolean isAcknowledged()
Description copied from interface:Interaction
Whether this interaction has already been acknowledged.
Each interaction can only be acknowledged once.- Specified by:
isAcknowledged
in interfaceInteraction
- Returns:
- True, if this interaction has already been acknowledged
-
-