net.dv8tion.jda.api.events.message.react.MessageReactionRemoveEmojiEvent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation
Show all versions of JDA Show documentation
Java wrapper for the popular chat & VOIP service: Discord https://discord.com
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.events.message.react;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.MessageReaction;
import net.dv8tion.jda.api.entities.channel.middleman.MessageChannel;
import net.dv8tion.jda.api.entities.emoji.Emoji;
import net.dv8tion.jda.api.entities.emoji.EmojiUnion;
import net.dv8tion.jda.api.events.message.GenericMessageEvent;
import javax.annotation.Nonnull;
/**
* Indicates that all reactions for a specific emoji were removed by a moderator.
*
* Can be used to detect which emoji was removed.
*
*
Requirements
*
*
This event requires at least one of the following intents (Will not fire at all if neither is enabled):
*
* - {@link net.dv8tion.jda.api.requests.GatewayIntent#GUILD_MESSAGE_REACTIONS GUILD_MESSAGE_REACTIONS} to work in guild text channels
* - {@link net.dv8tion.jda.api.requests.GatewayIntent#DIRECT_MESSAGE_REACTIONS DIRECT_MESSAGE_REACTIONS} to work in private channels
*
*/
public class MessageReactionRemoveEmojiEvent extends GenericMessageEvent
{
private final MessageReaction reaction;
public MessageReactionRemoveEmojiEvent(@Nonnull JDA api, long responseNumber, long messageId, @Nonnull MessageChannel channel, @Nonnull MessageReaction reaction)
{
super(api, responseNumber, messageId, channel);
this.reaction = reaction;
}
/**
* The {@link MessageReaction} that was removed.
*
* @return The removed MessageReaction
*/
@Nonnull
public MessageReaction getReaction()
{
return reaction;
}
/**
* The reaction {@link Emoji}.
*
Shortcut for {@code getReaction().getEmoji()}.
*
* @return The Emoji for the reaction
*/
@Nonnull
public EmojiUnion getEmoji()
{
return reaction.getEmoji();
}
}