Class Event<T extends GenericInteractionCreateEvent>

java.lang.Object

io.github.kaktushose.jdac.dispatching.events.Event<T>

Type Parameters:

T - the type of GenericInteractionCreateEvent this event represents

All Implemented Interfaces:

ISnowflake, Interaction

Direct Known Subclasses:

AutoCompleteEvent, ReplyableEvent

public abstract sealed class Event<T extends GenericInteractionCreateEvent>
extends Object
implements Interaction
permits ReplyableEvent<T>, AutoCompleteEvent

Abstract base event for all interaction events, like CommandEvent.

This class also holds the GenericInteractionCreateEvent and provides some shortcut methods to directly access its content.

See Also:

• AutoCompleteEvent
• CommandEvent
• ComponentEvent
• ModalEvent

Constructor Summary

Constructors

Constructor	Description
Event()

Method Summary

Modifier and Type	Method	Description
void	closeRuntime()	Closes the underlying Runtime.
@Nullable Channel	getChannel()
long	getChannelIdLong()
InteractionContextType	getContext()
List<Entitlement>	getEntitlements()
@Nullable Guild	getGuild()
long	getIdLong()
IntegrationOwners	getIntegrationOwners()
JDA	getJDA()
@Nullable Member	getMember()
String	getToken()
int	getTypeRaw()
User	getUser()
DiscordLocale	getUserLocale()
I18n	i18n()	Gets the I18n instance.
<I> @Nullable I	interactionInstance(Class<I> interactionClass)	Returns an instance of a class annotated with Interaction, that is bound to the underlying Runtime.
boolean	isAcknowledged()
T	jdaEvent()	Returns the underlying GenericInteractionCreateEvent of this event
KeyValueStore	kv()	Returns the KeyValueStore of this Runtime.
String	localize(String key, Entry... placeholders)	Gets a localization message for the given key using the underlying I18n instance.
MessageResolver	messageResolver()	Gets the MessageResolver instance
String	resolve(String message, Entry... placeholders)	Resolved the given message with help of the underlying MessageResolver instance, thus performing localization and emoji resolution.
String	runtimeId()	Returns the id of the Runtime this event is dispatched in.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Interaction

getChannelId, getChannelType, getGuildChannel, getGuildLocale, getMessageChannel, getType, isFromAttachedGuild, isFromGuild

Methods inherited from interface ISnowflake

getId, getTimeCreated

Constructor Details

Event

public Event()

Method Details

jdaEvent

public T jdaEvent()

Returns the underlying GenericInteractionCreateEvent of this event

Returns:

the GenericInteractionCreateEvent

runtimeId

public String runtimeId()

Returns the id of the Runtime this event is dispatched in.

Returns:

the id of the current Runtime

closeRuntime

public void closeRuntime()

Closes the underlying Runtime. This will ignore any new jda events belonging to this interaction, resulting in the freeing of occupied resources for gc.

This is only needed if the expiration strategy ExpirationStrategy.Explicit is used.

kv

public KeyValueStore kv()

Returns the KeyValueStore of this Runtime.

The KeyValueStore can be accessed during the Middleware execution as well as any interaction execution. Its content will be the same as long as the executions take place in the same Runtime.

Returns:

the KeyValueStore

interactionInstance

public <I> @Nullable I interactionInstance(Class<I> interactionClass)

Returns an instance of a class annotated with Interaction, that is bound to the underlying Runtime.

Returns:

the interaction class instance

i18n

public I18n i18n()

Gets the I18n instance.

Returns:

the I18n instance.

messageResolver

public MessageResolver messageResolver()

Gets the MessageResolver instance

Returns:

the MessageResolver instance

localize

public String localize(String key,
 Entry... placeholders)

Gets a localization message for the given key using the underlying I18n instance.

Automatically resolves the Locale using GenericInteractionCreateEvent.getUserLocale(). Use I18n.localize(Locale, String, Entry...) (obtained via i18n()) if you want to use a different locale.

Returns:

the localized message or the key if not found

resolve

public String resolve(String message,
 Entry... placeholders)

Resolved the given message with help of the underlying MessageResolver instance, thus performing localization and emoji resolution.

Automatically resolves the Locale using GenericInteractionCreateEvent.getUserLocale(). Use MessageResolver.resolve(String, Locale, Entry...) (obtained via messageResolver()) if you want to use a different locale.

Returns:

the resolved message

getTypeRaw

public int getTypeRaw()

Specified by:

getTypeRaw in interface Interaction

getToken

public String getToken()

Specified by:

getToken in interface Interaction

getGuild

public @Nullable Guild getGuild()

Specified by:

getGuild in interface Interaction

getUser

public User getUser()

Specified by:

getUser in interface Interaction

getMember

public @Nullable Member getMember()

Specified by:

getMember in interface Interaction

isAcknowledged

public boolean isAcknowledged()

Specified by:

isAcknowledged in interface Interaction

getChannel

public @Nullable Channel getChannel()

Specified by:

getChannel in interface Interaction

getChannelIdLong

public long getChannelIdLong()

Specified by:

getChannelIdLong in interface Interaction

getUserLocale

public DiscordLocale getUserLocale()

Specified by:

getUserLocale in interface Interaction

getEntitlements

public List<Entitlement> getEntitlements()

Specified by:

getEntitlements in interface Interaction

getJDA

public JDA getJDA()

Specified by:

getJDA in interface Interaction

getIdLong

public long getIdLong()

Specified by:

getIdLong in interface ISnowflake

getIntegrationOwners

public IntegrationOwners getIntegrationOwners()

Specified by:

getIntegrationOwners in interface Interaction

getContext

public InteractionContextType getContext()

Specified by:

getContext in interface Interaction