MessageReaction (JDA 3.8.3

java.lang.Object
- net.dv8tion.jda.core.entities.MessageReaction

```
public class MessageReaction
extends java.lang.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

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

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.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
`Group`	`getGroup()`	The `Group` this Reaction was used in or `null` if this is not from type `ChannelType.GROUP`!
`Guild`	`getGuild()`	The `Guild` this Reaction was used in, this might return `null` when this Reaction was not used in a MessageChannel from the ChannelType `TEXT`!
`JDA`	`getJDA()`	The JDA instance of this Reaction
`java.lang.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`!
`ReactionPaginationAction`	`getUsers()`	Retrieves the `Users` that already reacted with this MessageReaction.
`ReactionPaginationAction`	`getUsers(int amount)`	Retrieves the `Users` that already reacted with this MessageReaction.
`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<java.lang.Void>`	`removeReaction()`	Removes this Reaction from the Message.
`RestAction<java.lang.Void>`	`removeReaction(User user)`	Removes this Reaction from the Message.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MessageReaction
```
public MessageReaction(MessageChannel channel,
                       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 Detail
  - getJDA
```
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
    
    Returns:
    
    True, if we reacted with this reaction
  - 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:
    
    java.lang.IllegalStateException - If this MessageReaction is from an event which does not provide a count
  - getChannelType
```
public ChannelType getChannelType()
```
    The ChannelType this Reaction was used in.
    
    Returns:
    
    The ChannelType
  - isFromType
```
public boolean isFromType(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
```
public Guild getGuild()
```
    The Guild this Reaction was used in, this might return null when this Reaction was not used in a MessageChannel from the ChannelType TEXT!
    
    Returns:
    
    Guild this Reaction was used in, or null
  - getTextChannel
```
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
```
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
  - getGroup
```
public Group getGroup()
```
    The Group this Reaction was used in or null if this is not from type ChannelType.GROUP!
    
    Returns:
    
    The Group or null
  - getChannel
```
public MessageChannel getChannel()
```
    The MessageChannel this Reaction was used in.
    
    Returns:
    
    The channel this Reaction was used in
  - getReactionEmote
```
public MessageReaction.ReactionEmote getReactionEmote()
```
    The ReactionEmote of this Reaction
    
    Returns:
    
    The final instance of this Reaction's Emote/Emoji
  - getMessageId
```
public java.lang.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
  - getUsers
```
@CheckReturnValue
public ReactionPaginationAction getUsers()
```
    Retrieves the Users that already reacted with this MessageReaction.
    This is an overload of getUsers(int) with 100.
    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
    Retrieves an immutable list of users that reacted with this Reaction.
  - getUsers
```
@CheckReturnValue
public ReactionPaginationAction getUsers(int amount)
```
    Retrieves the Users that already reacted with this MessageReaction. The maximum amount of users that can be retrieved is 100.
    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:
    
    amount - the amount of users to retrieve
    
    Returns:
    
    ReactionPaginationAction
    Retrieves an immutable list of users that reacted with this Reaction.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the provided amount is not between 1-100
  - removeReaction
```
@CheckReturnValue
public RestAction<java.lang.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
```
@CheckReturnValue
public RestAction<java.lang.Void> removeReaction(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 - Type: Void Nothing is returned on success
    
    Throws:
    
    java.lang.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
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class MessageReaction

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MessageReaction

Method Detail

getJDA

isSelf

getCount

getChannelType

isFromType

getGuild

getTextChannel

getPrivateChannel

getGroup

getChannel

getReactionEmote

getMessageId

getMessageIdLong

getUsers

getUsers

removeReaction

removeReaction

equals

toString