Class MessageBulkDeleteEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.message.MessageBulkDeleteEvent

All Implemented Interfaces:

GenericEvent

public class MessageBulkDeleteEvent
extends Event

Indicates that a bulk deletion is executed in a GuildMessageChannel.
Set JDABuilder.setBulkDeleteSplittingEnabled(boolean) to false in order to enable this event.

Can be used to detect that a large chunk of Messages is deleted in a GuildMessageChannel. Providing a list of Message IDs and the specific GuildMessageChannel.

Requirements

This event requires at least one of the following intents (Will not fire at all if neither is enabled):

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

Constructor Summary

Constructors

Constructor	Description
MessageBulkDeleteEvent(JDA api, long responseNumber, GuildMessageChannel channel, List<String> messageIds)

Method Summary

Modifier and Type	Method	Description
GuildMessageChannelUnion	getChannel()	The GuildMessageChannel where the messages have been deleted
Guild	getGuild()	The Guild where the messages were deleted.
List<String>	getMessageIds()	List of messages that have been deleted.

Methods inherited from class Event

getJDA, getRawData, getResponseNumber, toString

Methods inherited from class Object

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

Constructor Details

MessageBulkDeleteEvent

public MessageBulkDeleteEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 GuildMessageChannel channel,
 @Nonnull
 List<String> messageIds)

Method Details

getChannel

@Nonnull
public GuildMessageChannelUnion getChannel()

The GuildMessageChannel where the messages have been deleted

Returns:

The TextChannel

getGuild

@Nonnull
public Guild getGuild()

The Guild where the messages were deleted.

Returns:

The Guild

getMessageIds

@Nonnull
public List<String> getMessageIds()

List of messages that have been deleted.

Returns:

The list of message ids