Package net.dv8tion.jda.api.events.message.guild.react

Class GenericGuildMessageReactionEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.guild.GenericGuildEvent

net.dv8tion.jda.api.events.message.guild.GenericGuildMessageEvent

net.dv8tion.jda.api.events.message.guild.react.GenericGuildMessageReactionEvent

All Implemented Interfaces:

GenericEvent

Direct Known Subclasses:

GuildMessageReactionAddEvent, GuildMessageReactionRemoveEvent

public abstract class GenericGuildMessageReactionEvent
extends GenericGuildMessageEvent

Indicates that a MessageReaction was added or removed in a TextChannel.

Can be used to detect when a reaction is added or removed in a TextChannel.

Requirements

These events require the GUILD_MESSAGE_REACTIONS intent to be enabled.

Constructor Summary

Constructors

Constructor	Description
GenericGuildMessageReactionEvent(JDA api, long responseNumber, Member user, MessageReaction reaction, long userId)

Method Summary

Modifier and Type	Method	Description
Member	getMember()	The Member instance for the reacting user This might be missing if the user was not previously cached or the member was removed.
MessageReaction	getReaction()	The MessageReaction
MessageReaction.ReactionEmote	getReactionEmote()	The ReactionEmote Shortcut for getReaction().getReactionEmote()
User	getUser()	The reacting User This might be missing if the user was not previously cached or the member was removed.
java.lang.String	getUserId()	The id for the user who owns the reaction.
long	getUserIdLong()	The id for the user who owns the reaction.
RestAction<Member>	retrieveMember()	Retrieves the Member who owns the reaction.
RestAction<Message>	retrieveMessage()	Retrieves the message for this reaction event.
RestAction<User>	retrieveUser()	Retrieves the User who owns the reaction.

Methods inherited from class net.dv8tion.jda.api.events.message.guild.GenericGuildMessageEvent

getChannel, getMessageId, getMessageIdLong

Methods inherited from class net.dv8tion.jda.api.events.guild.GenericGuildEvent

getGuild

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

Constructor Detail

GenericGuildMessageReactionEvent

public GenericGuildMessageReactionEvent(@Nonnull
                                        JDA api,
                                        long responseNumber,
                                        @Nullable
                                        Member user,
                                        @Nonnull
                                        MessageReaction reaction,
                                        long userId)

Method Detail

getUserId

@Nonnull
public java.lang.String getUserId()

The id for the user who owns the reaction.

Returns:

The user id

getUserIdLong

public long getUserIdLong()

The id for the user who owns the reaction.

Returns:

The user id

getUser

@Nullable
public User getUser()

The reacting User
This might be missing if the user was not previously cached or the member was removed. Use retrieveUser() to load the user.

Returns:

The reacting user or null if this information is missing

See Also:

getUserIdLong()

getMember

@Nullable
public Member getMember()

The Member instance for the reacting user
This might be missing if the user was not previously cached or the member was removed. Use retrieveMember() to load the member.

Returns:

The member instance for the reacting user or null if this information is missing

getReaction

@Nonnull
public MessageReaction getReaction()

The MessageReaction

Returns:

The message reaction

getReactionEmote

@Nonnull
public MessageReaction.ReactionEmote getReactionEmote()

The ReactionEmote
Shortcut for getReaction().getReactionEmote()

Returns:

The reaction emote

retrieveUser

@Nonnull
@CheckReturnValue
public RestAction<User> retrieveUser()

Retrieves the User who owns the reaction.
If a user is known, this will return getUser().

Returns:

RestAction - Type: User

Since:

4.2.1

retrieveMember

@Nonnull
@CheckReturnValue
public RestAction<Member> retrieveMember()

Retrieves the Member who owns the reaction.
If a member is known, this will return getMember().

Note that banning a member will also fire GuildMessageReactionRemoveEvent and no member will be available in those cases. An UNKNOWN_MEMBER error response should be the failure result.

Returns:

RestAction - Type: Member

Since:

4.2.1

retrieveMessage

@Nonnull
@CheckReturnValue
public RestAction<Message> retrieveMessage()

Retrieves the message for this reaction event.
Simple shortcut for getChannel().retrieveMessageById(getMessageId()).

The Message.getMember() method will always return null for the resulting message. To retrieve the member you can use getGuild().retrieveMember(message.getAuthor()).

Returns:

RestAction - Type: Message

Since:

4.2.1