Package net.dv8tion.jda.api.events.interaction

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, ModalInteractionEvent
public class GenericInteractionCreateEvent extends Event implements Interaction
Indicates that an Interaction 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:

  • Constructor Details

  • Method Details

    • getInteraction

      @Nonnull public Interaction getInteraction()
      The Interaction 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 interface Interaction
      Returns:
      The interaction token

    • getTypeRaw

      public int getTypeRaw()
      Description copied from interface: Interaction
      The raw interaction type.
      It is recommended to use Interaction.getType() instead.
      Specified by:
      getTypeRaw in interface Interaction
      Returns:
      The raw interaction type

    • getGuild

      @Nullable public Guild getGuild()
      Description copied from interface: Interaction
      The Guild this interaction happened in.
      This is null in direct messages.
      Specified by:
      getGuild in interface Interaction
      Returns:
      The Guild or null

    • getChannel

      @Nullable public Channel getChannel()
      Description copied from interface: Interaction
      The channel this interaction happened in.
      Specified by:
      getChannel in interface Interaction
      Returns:
      The channel or null if the channel is not provided

    • getChannelIdLong

      public long getChannelIdLong()
      Description copied from interface: Interaction
      The ID of the channel this interaction happened in.
      This might be 0 if no channel context is provided in future interaction types.
      Specified by:
      getChannelIdLong in interface Interaction
      Returns:
      The channel ID, or 0 if no channel context is provided

    • getUserLocale

      @Nonnull public DiscordLocale getUserLocale()
      Description copied from interface: Interaction
      Returns the selected language of the invoking user.
      Specified by:
      getUserLocale in interface Interaction
      Returns:
      The language of the invoking user

    • getGuildLocale

      @Nonnull public DiscordLocale getGuildLocale()
      Description copied from interface: Interaction
      Returns the preferred language of the Guild.
      This is identical to getGuild().getLocale().
      Specified by:
      getGuildLocale in interface Interaction
      Returns:
      The preferred language of the Guild

    • getContext

      @Nonnull public InteractionContextType getContext()
      Description copied from interface: Interaction
      Gets the context in which this command was executed.
      Specified by:
      getContext in interface Interaction
      Returns:
      The context in which this command was executed

    • getIntegrationOwners

      @Nonnull public IntegrationOwners getIntegrationOwners()
      Description copied from interface: Interaction
      Returns the integration owners of this interaction, which depends on how the app was installed.
      Specified by:
      getIntegrationOwners in interface Interaction
      Returns:
      The integration owners of this interaction

    • getMember

      @Nullable public Member getMember()
      Description copied from interface: Interaction
      The Member who caused this interaction.
      This is null if the interaction is not from a guild.
      Specified by:
      getMember in interface Interaction
      Returns:
      The Member

    • getUser

      @Nonnull public User getUser()
      Description copied from interface: Interaction
      The User who caused this interaction.
      Specified by:
      getUser in interface Interaction
      Returns:
      The User

    • getEntitlements

      @Nonnull public List<Entitlement> getEntitlements()
      Description copied from interface: Interaction
      Returns the list of entitlements for the current guild and user.
      If this interaction is not from a guild, it will only contain entitlements of the user.
      Specified by:
      getEntitlements in interface Interaction
      Returns:
      The List of Entitlement

    • 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 interface ISnowflake
      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 interface Interaction
      Returns:
      True, if this interaction has already been acknowledged