Class Event<T extends GenericInteractionCreateEvent>

java.lang.Object

com.github.kaktushose.jda.commands.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

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	event
protected final InteractionRegistry	registry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Event(T event, @NotNull InteractionRegistry registry, @NotNull com.github.kaktushose.jda.commands.dispatching.Runtime runtime)	Constructs a new Event.

Method Summary

Modifier and Type	Method	Description
void	closeRuntime()	Closes the underlying Runtime.
@Nullable Channel	getChannel()
long	getChannelIdLong()
@NotNull List<Entitlement>	getEntitlements()
@Nullable Guild	getGuild()
long	getIdLong()
@NotNull JDA	getJDA()
@Nullable Member	getMember()
@NotNull String	getToken()
int	getTypeRaw()
@NotNull User	getUser()
@NotNull DiscordLocale	getUserLocale()
boolean	isAcknowledged()
T	jdaEvent()	Returns the underlying GenericInteractionCreateEvent of this event
@NotNull KeyValueStore	kv()	Returns the KeyValueStore of this Runtime.
@NotNull String	runtimeId()	Returns the id of the Runtime this event is dispatched in.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.dv8tion.jda.api.interactions.Interaction

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

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

getId, getTimeCreated

Field Details

event

protected final T extends GenericInteractionCreateEvent event

registry

protected final InteractionRegistry registry

Constructor Details

Event

protected Event(@NotNull
 T event,
 @NotNull
 @NotNull InteractionRegistry registry,
 @NotNull
 @NotNull com.github.kaktushose.jda.commands.dispatching.Runtime runtime)

Constructs a new Event.

Parameters:

event - the subtype Event of GenericInteractionCreateEvent

registry - the corresponding InteractionRegistry

runtime - the Runtime this event lives in

Method Details

jdaEvent

@NotNull
public T jdaEvent()

Returns the underlying GenericInteractionCreateEvent of this event

Returns:

the GenericInteractionCreateEvent

runtimeId

@NotNull
public @NotNull 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

@NotNull
public @NotNull 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

getTypeRaw

public int getTypeRaw()

Specified by:

getTypeRaw in interface Interaction

getToken

@NotNull
public @NotNull String getToken()

Specified by:

getToken in interface Interaction

getGuild

@Nullable
public @Nullable Guild getGuild()

Specified by:

getGuild in interface Interaction

getUser

@NotNull
public @NotNull User getUser()

Specified by:

getUser in interface Interaction

getMember

@Nullable
public @Nullable Member getMember()

Specified by:

getMember in interface Interaction

isAcknowledged

public boolean isAcknowledged()

Specified by:

isAcknowledged in interface Interaction

getChannel

@Nullable
public @Nullable Channel getChannel()

Specified by:

getChannel in interface Interaction

getChannelIdLong

public long getChannelIdLong()

Specified by:

getChannelIdLong in interface Interaction

getUserLocale

@NotNull
public @NotNull DiscordLocale getUserLocale()

Specified by:

getUserLocale in interface Interaction

getEntitlements

@NotNull
public @NotNull List<Entitlement> getEntitlements()

Specified by:

getEntitlements in interface Interaction

getJDA

@NotNull
public @NotNull JDA getJDA()

Specified by:

getJDA in interface Interaction

getIdLong

public long getIdLong()

Specified by:

getIdLong in interface ISnowflake