Package discord4j.core.event.domain.interaction

Class UserInteractionEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.interaction.InteractionCreateEvent

discord4j.core.event.domain.interaction.DeferrableInteractionEvent

discord4j.core.event.domain.interaction.ApplicationCommandInteractionEvent

discord4j.core.event.domain.interaction.UserInteractionEvent

@Experimental
public class UserInteractionEvent
extends ApplicationCommandInteractionEvent

Dispatched when a user uses a user command (user context menu)

You are required to respond to this interaction within a three-second window by using one of the following:

• DeferrableInteractionEvent.reply() to directly include a message
• DeferrableInteractionEvent.deferReply() to acknowledge without a message, typically to perform a background task and give the user a loading state until it is edited
• DeferrableInteractionEvent.presentModal(String, String, Collection) to pop a modal for the user to interact with

See InteractionCreateEvent for more details about valid operations.

This is not directly dispatched by Discord, but is a utility specialization of ApplicationCommandInteractionEvent.

Constructor Summary

Constructors

Constructor	Description
UserInteractionEvent(GatewayDiscordClient gateway, ShardInfo shardInfo, Interaction interaction)

Method Summary

Modifier and Type	Method	Description
User	getResolvedUser()	Gets the resolved targeted User.
Snowflake	getTargetId()	Gets the ID of the targeted User.
Mono<User>	getTargetUser()	Requests to retrieve the targeted User.
Mono<User>	getTargetUser(EntityRetrievalStrategy retrievalStrategy)	Requests to retrieve the targeted User.

Methods inherited from class discord4j.core.event.domain.interaction.ApplicationCommandInteractionEvent

getCommandId, getCommandName, getCommandType

Methods inherited from class discord4j.core.event.domain.interaction.DeferrableInteractionEvent

acknowledge, acknowledgeEphemeral, createFollowup, createFollowup, createFollowup, deferReply, deferReply, deleteFollowup, deleteReply, editFollowup, editFollowup, editReply, editReply, editReply, getInteractionResponse, getReply, presentModal, presentModal, presentModal, reply, reply, reply, reply

Methods inherited from class discord4j.core.event.domain.interaction.InteractionCreateEvent

createInteractionResponse, createInteractionResponse, getInteraction

Methods inherited from class discord4j.core.event.domain.Event

getClient, getShardInfo

Methods inherited from class java.lang.Object

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

Constructor Details

UserInteractionEvent

public UserInteractionEvent(GatewayDiscordClient gateway,
 ShardInfo shardInfo,
 Interaction interaction)

Method Details

getResolvedUser

public User getResolvedUser()

Gets the resolved targeted User.

Returns:

The resolved targeted User.

getTargetId

public Snowflake getTargetId()

Gets the ID of the targeted User.

Returns:

The ID of the targeted User.

getTargetUser

public Mono<User> getTargetUser()

Requests to retrieve the targeted User.

Returns:

A Mono where, upon successful completion, emits the User targeted by the user. If an error is received, it is emitted through the Mono.

getTargetUser

public Mono<User> getTargetUser(EntityRetrievalStrategy retrievalStrategy)

Requests to retrieve the targeted User.

Parameters:

retrievalStrategy - The strategy to use to get the target User

Returns:

A Mono where, upon successful completion, emits the User targeted by the user. If an error is received, it is emitted through the Mono.