net.dv8tion.jda.api.events.message.MessageReceivedEvent 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;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Member;
import net.dv8tion.jda.api.entities.Message;
import net.dv8tion.jda.api.entities.User;
import net.dv8tion.jda.api.entities.Webhook;
import net.dv8tion.jda.api.entities.channel.concrete.PrivateChannel;
import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Indicates that a Message was received in a {@link net.dv8tion.jda.api.entities.channel.middleman.MessageChannel MessageChannel}.
*
This includes {@link TextChannel TextChannel} and {@link PrivateChannel PrivateChannel}!
*
* Can be used to detect that a Message is received in either a guild- or private channel. Providing a MessageChannel and 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_MESSAGES GUILD_MESSAGES} to work in guild text channels
* - {@link net.dv8tion.jda.api.requests.GatewayIntent#DIRECT_MESSAGES DIRECT_MESSAGES} to work in private channels
*
*/
//TODO-v5: Consider renaming this to MessageCreateEvent to match standard event naming (and to match Discord naming!)
public class MessageReceivedEvent extends GenericMessageEvent
{
private final Message message;
public MessageReceivedEvent(@Nonnull JDA api, long responseNumber, @Nonnull Message message)
{
super(api, responseNumber, message.getIdLong(), message.getChannel());
this.message = message;
}
/**
* The received {@link net.dv8tion.jda.api.entities.Message Message} object.
*
* @return The received {@link net.dv8tion.jda.api.entities.Message Message} object.
*/
@Nonnull
public Message getMessage()
{
return message;
}
/**
* The Author of the Message received as {@link net.dv8tion.jda.api.entities.User User} object.
*
This will be never-null but might be a fake user if Message was sent via Webhook (Guild only).
* See {@link Webhook#getDefaultUser()}.
*
* @return The Author of the Message.
*
* @see #isWebhookMessage()
*/
@Nonnull
public User getAuthor()
{
return message.getAuthor();
}
/**
* The Author of the Message received as {@link net.dv8tion.jda.api.entities.Member Member} object.
*
This will be {@code null} in case of Message being received in
* a {@link PrivateChannel PrivateChannel}
* or {@link #isWebhookMessage() isWebhookMessage()} returning {@code true}.
*
* @return The Author of the Message as null-able Member object.
*
* @see #isWebhookMessage()
*/
@Nullable
public Member getMember()
{
return message.getMember();
}
/**
* Whether or not the Message received was sent via a Webhook.
*
This is a shortcut for {@code getMessage().isWebhookMessage()}.
*
* @return True, if the Message was sent via Webhook
*/
public boolean isWebhookMessage()
{
return getMessage().isWebhookMessage();
}
}