net.dv8tion.jda.api.events.message.react.MessageReactionAddEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation

Java wrapper for the popular chat & VOIP service: Discord https://discord.com

The newest version!

/*
 * 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.Member;
import net.dv8tion.jda.api.entities.MessageReaction;
import net.dv8tion.jda.api.entities.User;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Indicates that a user added a reaction to a message
 * 
This includes unicode and custom emoji
 *
 * Can be used to track when a user adds a reaction to a message
 *
 * 
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 MessageReactionAddEvent extends GenericMessageReactionEvent
{
    private final long messageAuthorId;

    public MessageReactionAddEvent(@Nonnull JDA api, long responseNumber, @Nullable User user,
                                   @Nullable Member member, @Nonnull MessageReaction reaction, long userId, long messageAuthorId)
    {
        super(api, responseNumber, user, member, reaction, userId);
        this.messageAuthorId = messageAuthorId;
    }

    /**
     * The user id of the original message author.
     * 
This might be 0 for webhook messages.
     *
     * @return The user id of the original message author.
     */
    @Nonnull
    public String getMessageAuthorId()
    {
        return Long.toUnsignedString(messageAuthorId);
    }


    /**
     * The user id of the original message author.
     * 
This might be 0 for webhook messages.
     *
     * @return The user id of the original message author.
     */
    public long getMessageAuthorIdLong()
    {
        return messageAuthorId;
    }
}