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

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 TextChannel.
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 TextChannel. Providing a list of Message IDs and the specific TextChannel.

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 text channels
• DIRECT_MESSAGES to work in private channels

Constructor Summary

Constructors

Constructor	Description
MessageBulkDeleteEvent(JDA api, long responseNumber, TextChannel channel, java.util.List<java.lang.String> messageIds)

Method Summary

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

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

MessageBulkDeleteEvent

public MessageBulkDeleteEvent(@Nonnull
                              JDA api,
                              long responseNumber,
                              @Nonnull
                              TextChannel channel,
                              @Nonnull
                              java.util.List<java.lang.String> messageIds)

Method Detail

getChannel

@Nonnull
public TextChannel getChannel()

The TextChannel 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 java.util.List<java.lang.String> getMessageIds()

List of messages that have been deleted.

Returns:

The list of message ids