Package net.dv8tion.jda.api.entities

Class MessageReaction

java.lang.Object

net.dv8tion.jda.api.entities.MessageReaction

public class MessageReaction
extends Object

An object representing a single MessageReaction from Discord. This is an immutable object and is not updated by method calls or changes in Discord. A new snapshot instance built from Discord is needed to see changes.

Since:

3.0

See Also:

• Message.getReactions()
• Message.getReactionByUnicode(String)
• Message.getReactionById(long)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageReaction.ReactionEmote	Represents an Emoji/Emote of a MessageReaction This is used to wrap both emojis and emotes

Constructor Summary

Constructors

Constructor	Description
MessageReaction(MessageChannel channel, MessageReaction.ReactionEmote emote, long messageId, boolean self, int count)	Creates a new MessageReaction instance

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	clearReactions()	Removes this entire reaction from the message.
boolean	equals(Object obj)
MessageChannel	getChannel()	The MessageChannel this Reaction was used in.
ChannelType	getChannelType()	The ChannelType this Reaction was used in.
int	getCount()	The amount of users that already reacted with this Reaction This is not updated, it is a final int per Reaction instance
Guild	getGuild()	The Guild this Reaction was used in.
GuildMessageChannel	getGuildChannel()	The GuildMessageChannel this Reaction was used in.
JDA	getJDA()	The JDA instance of this Reaction
String	getMessageId()	The message id this reaction is attached to
long	getMessageIdLong()	The message id this reaction is attached to
PrivateChannel	getPrivateChannel()	The PrivateChannel this Reaction was used in or null if this is not from type ChannelType.PRIVATE!
MessageReaction.ReactionEmote	getReactionEmote()	The ReactionEmote of this Reaction
TextChannel	getTextChannel()	The TextChannel this Reaction was used in or null if this is not from type ChannelType.TEXT!
boolean	hasCount()	Whether this reaction can provide a count via getCount().
boolean	isFromType(ChannelType type)	Whether this Reaction was used in a MessageChannel of the specified ChannelType.
boolean	isSelf()	Whether the currently logged in account has reacted with this reaction
RestAction<Void>	removeReaction()	Removes this Reaction from the Message.
RestAction<Void>	removeReaction(User user)	Removes this Reaction from the Message.
ReactionPaginationAction	retrieveUsers()	Retrieves the Users that already reacted with this MessageReaction.
String	toString()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MessageReaction

public MessageReaction(@Nonnull
 MessageChannel channel,
 @Nonnull
 MessageReaction.ReactionEmote emote,
 long messageId,
 boolean self,
 int count)

Creates a new MessageReaction instance

Parameters:

channel - The MessageChannel this Reaction was used in

emote - The ReactionEmote that was used

messageId - The message id this reaction is attached to

self - Whether we already reacted with this Reaction

count - The amount of people that reacted with this Reaction

Method Details

getJDA

@Nonnull
public JDA getJDA()

The JDA instance of this Reaction

Returns:

The JDA instance of this Reaction

isSelf

public boolean isSelf()

Whether the currently logged in account has reacted with this reaction

This will always be false for events. Discord does not provide this information for reaction events. You can use MessageChannel.retrieveMessageById(String) to get this information on a complete message.

Returns:

True, if we reacted with this reaction

hasCount

public boolean hasCount()

Whether this reaction can provide a count via getCount().
This is usually not provided for reactions coming from MessageReactionAddEvent or similar.

Returns:

True, if a count is available

See Also:

• getCount()

getCount

public int getCount()

The amount of users that already reacted with this Reaction
This is not updated, it is a final int per Reaction instance

This value is not available in events such as MessageReactionAddEvent and MessageReactionRemoveEvent in which case an IllegalStateException is thrown!

Returns:

The amount of users that reacted with this Reaction

Throws:

IllegalStateException - If this MessageReaction is from an event which does not provide a count

getChannelType

@Nonnull
public ChannelType getChannelType()

The ChannelType this Reaction was used in.

Returns:

The ChannelType

isFromType

public boolean isFromType(@Nonnull
 ChannelType type)

Whether this Reaction was used in a MessageChannel of the specified ChannelType.

Parameters:

type - The ChannelType to compare

Returns:

True, if this Reaction was used in a MessageChannel from the specified ChannelType

getGuild

@Nullable
public Guild getGuild()

The Guild this Reaction was used in. This will return null if the channel this Reaction was used in is not part of a Guild.

Returns:

Guild this Reaction was used in, or null

getTextChannel

@Nullable
public TextChannel getTextChannel()

The TextChannel this Reaction was used in or null if this is not from type ChannelType.TEXT!

Returns:

The TextChannel or null

getPrivateChannel

@Nullable
public PrivateChannel getPrivateChannel()

The PrivateChannel this Reaction was used in or null if this is not from type ChannelType.PRIVATE!

Returns:

The PrivateChannel or null

getChannel

@Nonnull
public MessageChannel getChannel()

The MessageChannel this Reaction was used in.

Returns:

The channel this Reaction was used in

getGuildChannel

@Nullable
public GuildMessageChannel getGuildChannel()

The GuildMessageChannel this Reaction was used in.

Returns:

The channel this Reaction was used in or null if it wasn't used in a Guild

getReactionEmote

@Nonnull
public MessageReaction.ReactionEmote getReactionEmote()

The ReactionEmote of this Reaction

Returns:

The final instance of this Reaction's Emote/Emoji

getMessageId

@Nonnull
public String getMessageId()

The message id this reaction is attached to

Returns:

The message id this reaction is attached to

getMessageIdLong

public long getMessageIdLong()

The message id this reaction is attached to

Returns:

The message id this reaction is attached to

retrieveUsers

@Nonnull
@CheckReturnValue
public ReactionPaginationAction retrieveUsers()

Retrieves the Users that already reacted with this MessageReaction.

Possible ErrorResponses include:

• UNKNOWN_MESSAGE
  If the message this reaction was attached to got deleted.
• UNKNOWN_CHANNEL
  If the channel this reaction was used in got deleted.
• MISSING_ACCESS
  If we were removed from the channel/guild

Returns:

ReactionPaginationAction

removeReaction

@Nonnull
@CheckReturnValue
public RestAction<Void> removeReaction()

Removes this Reaction from the Message.
This will remove our own reaction as an overload of removeReaction(User).

Possible ErrorResponses include:

• UNKNOWN_MESSAGE
  If the message this reaction was attached to got deleted.
• UNKNOWN_CHANNEL
  If the channel this reaction was used in got deleted.
• MISSING_ACCESS
  If we were removed from the channel/guild

Returns:

RestAction - Type: Void Nothing is returned on success

removeReaction

@Nonnull
@CheckReturnValue
public RestAction<Void> removeReaction(@Nonnull
 User user)

Removes this Reaction from the Message.
This will remove the reaction of the User provided.

If the provided User did not react with this Reaction this does nothing.

Possible ErrorResponses include:

• UNKNOWN_MESSAGE
  If the message this reaction was attached to got deleted.
• UNKNOWN_CHANNEL
  If the channel this reaction was used in got deleted.
• MISSING_ACCESS
  If we were removed from the channel/guild

Parameters:

user - The User of which to remove the reaction

Returns:

RestAction Nothing is returned on success

Throws:

IllegalArgumentException - If the provided user is null.

InsufficientPermissionException - If the provided User is not us and we do not have permission to manage messages in the channel this reaction was used in

PermissionException - If the message is from another user in a PrivateChannel

clearReactions

@Nonnull
@CheckReturnValue
public RestAction<Void> clearReactions()

Removes this entire reaction from the message.
Unlike removeReaction(User), which removes the reaction of a single user, this will remove the reaction completely.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The currently logged in account lost access to the channel by either being removed from the guild or losing the VIEW_CHANNEL permission
• UNKNOWN_EMOJI
  The provided unicode emoji doesn't exist. Try using one of the example formats.
• UNKNOWN_MESSAGE
  The message was deleted.

Returns:

RestAction

Throws:

UnsupportedOperationException - If this reaction happened in a private channel

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in the channel

Since:

4.2.0

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object