Package net.dv8tion.jda.api.events.message

Class GenericMessageEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.message.GenericMessageEvent

All Implemented Interfaces:

GenericEvent

Direct Known Subclasses:

GenericMessageReactionEvent, MessageDeleteEvent, MessageEmbedEvent, MessageReactionRemoveAllEvent, MessageReactionRemoveEmoteEvent, MessageReceivedEvent, MessageUpdateEvent

public abstract class GenericMessageEvent
extends Event

Indicates that a Message was created/deleted/changed.
Every MessageEvent is an instance of this event and can be casted.

Can be used to detect any MessageEvent.

Requirements

These events require at least one of the following intents (Will not fire at all if neither is enabled):

• GUILD_MESSAGES to work in guild text channels
• DIRECT_MESSAGES to work in private channels

Constructor Summary

Constructors

Constructor	Description
GenericMessageEvent(JDA api, long responseNumber, long messageId, MessageChannel channel)

Method Summary

Modifier and Type	Method	Description
MessageChannel	getChannel()	The MessageChannel for this Message
ChannelType	getChannelType()	The ChannelType for this message
Guild	getGuild()	The Guild the Message was received in.
GuildMessageChannel	getGuildChannel()	The GuildMessageChannel for this Message if it was sent in a Guild.
String	getMessageId()	The id for this message
long	getMessageIdLong()	The id for this message
NewsChannel	getNewsChannel()	The NewsChannel the Message was received in.
PrivateChannel	getPrivateChannel()	The PrivateChannel the Message was received in.
TextChannel	getTextChannel()	The TextChannel the Message was received in.
ThreadChannel	getThreadChannel()	The ThreadChannel the Message was received in.
boolean	isFromGuild()	Whether this message was sent in a Guild.
boolean	isFromThread()	If the message event was from a ThreadChannel
boolean	isFromType(ChannelType type)	Indicates whether the message is from the specified ChannelType

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getResponseNumber

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericMessageEvent

public GenericMessageEvent(@Nonnull
                           JDA api,
                           long responseNumber,
                           long messageId,
                           @Nonnull
                           MessageChannel channel)

Method Detail

getChannel

@Nonnull
public MessageChannel getChannel()

The MessageChannel for this Message

Returns:

The MessageChannel

getGuildChannel

@Nonnull
public GuildMessageChannel getGuildChannel()

The GuildMessageChannel for this Message if it was sent in a Guild.
If this Message was not received from a Guild, this will throw an IllegalStateException.

Returns:

The GuildMessageChannel

Throws:

IllegalStateException - If this was not sent in a channel in a Guild.

getMessageId

@Nonnull
public String getMessageId()

The id for this message

Returns:

The id for this message

getMessageIdLong

public long getMessageIdLong()

The id for this message

Returns:

The id for this message

isFromType

public boolean isFromType(@Nonnull
                          ChannelType type)

Indicates whether the message is from the specified ChannelType

Parameters:

type - The ChannelType

Returns:

True, if the message is from the specified channel type

isFromGuild

public boolean isFromGuild()

Whether this message was sent in a Guild.
If this is false then getGuild() will throw an IllegalStateException.

Returns:

True, if getChannelType().isGuild() is true.

getChannelType

@Nonnull
public ChannelType getChannelType()

The ChannelType for this message

Returns:

The ChannelType

getGuild

@Nonnull
public Guild getGuild()

The Guild the Message was received in.
If this Message was not received in a TextChannel, this will throw an IllegalStateException.

Returns:

The Guild the Message was received in

Throws:

IllegalStateException - If this was not sent in a GuildChannel.

See Also:

isFromGuild(), isFromType(ChannelType), getChannelType()

getTextChannel

@Nonnull
public TextChannel getTextChannel()

The TextChannel the Message was received in.
If this Message was not received in a TextChannel, this will throw an IllegalStateException.

Returns:

The TextChannel the Message was received in

Throws:

IllegalStateException - If this was not sent in a TextChannel.

See Also:

isFromGuild(), isFromType(ChannelType), getChannelType()

getNewsChannel

@Nonnull
public NewsChannel getNewsChannel()

The NewsChannel the Message was received in.
If this Message was not received in a NewsChannel, this will throw an IllegalStateException.

Returns:

The NewsChannel the Message was received in

Throws:

IllegalStateException - If this was not sent in a NewsChannel.

See Also:

isFromGuild(), isFromType(ChannelType), getChannelType()

getPrivateChannel

@Nonnull
public PrivateChannel getPrivateChannel()

The PrivateChannel the Message was received in.
If this Message was not received in a PrivateChannel, this will throw an IllegalStateException.

Returns:

The PrivateChannel the Message was received in

Throws:

IllegalStateException - If this was not sent in a PrivateChannel.

See Also:

isFromGuild(), isFromType(ChannelType), getChannelType()

getThreadChannel

@Nonnull
public ThreadChannel getThreadChannel()

The ThreadChannel the Message was received in.
If this Message was not received in a ThreadChannel, this will throw an IllegalStateException.

Returns:

The ThreadChannel the Message was received in

Throws:

IllegalStateException - If this was not sent in a ThreadChannel.

See Also:

isFromGuild(), isFromType(ChannelType), getChannelType(), isFromThread()

isFromThread

public boolean isFromThread()

If the message event was from a ThreadChannel

Returns:

If the message event was from a ThreadChannel

See Also:

ChannelType.isThread()