discord4j.core.event.domain.message

Class MessageBulkDeleteEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.message.MessageEvent

discord4j.core.event.domain.message.MessageBulkDeleteEvent

public class MessageBulkDeleteEvent
extends MessageEvent

Dispatched when multiple messages are deleted at once.

Corresponding message deletes are NOT dispatched for messages included in this event.

This event is dispatched by Discord.

See Also:

Message Delete Bulk

Constructor Summary

Constructors

Constructor and Description
MessageBulkDeleteEvent(GatewayDiscordClient gateway, ShardInfo shardInfo, List<Long> messageIds, long channelId, long guildId, Set<Message> messages)

Method Summary

Modifier and Type	Method and Description
Mono<TextChannel>	getChannel() Requests to retrieve the TextChannel representation of the Channel the messages were deleted in.
Snowflake	getChannelId() Gets the Snowflake ID of the TextChannel the messages were deleted in.
Mono<Guild>	getGuild() Requests to retrieve the Guild the messages were deleted in.
Snowflake	getGuildId() Gets the Snowflake ID of the Guild the messages were deleted in.
Set<Snowflake>	getMessageIds() Gets a list of Snowflake IDs of the messages that were deleted.
Set<Message>	getMessages() Gets a list of Message objects there were deleted in this event.
String	toString()

Methods inherited from class discord4j.core.event.domain.Event

getClient, getShardInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageBulkDeleteEvent

public MessageBulkDeleteEvent(GatewayDiscordClient gateway,
                              ShardInfo shardInfo,
                              List<Long> messageIds,
                              long channelId,
                              long guildId,
                              Set<Message> messages)

Method Detail

getMessageIds

public Set<Snowflake> getMessageIds()

Gets a list of Snowflake IDs of the messages that were deleted.

Returns:

a list of IDs of the messages that were deleted.

getMessages

public Set<Message> getMessages()

Gets a list of Message objects there were deleted in this event.

Returns:

a list of Message objects that were deleted.

getChannelId

public Snowflake getChannelId()

Gets the Snowflake ID of the TextChannel the messages were deleted in.

Returns:

The ID of the TextChannel that the messages were deleted in.

getChannel

public Mono<TextChannel> getChannel()

Requests to retrieve the TextChannel representation of the Channel the messages were deleted in.

Returns:

A Mono where, upon successful completion, emits the TextChannel the messages were deleted from. If an error is received, it is emitted through the Mono.

getGuildId

public Snowflake getGuildId()

Gets the Snowflake ID of the Guild the messages were deleted in.

Returns:

The ID of the Guild the messages were deleted in.

getGuild

public Mono<Guild> getGuild()

Requests to retrieve the Guild the messages were deleted in.

Returns:

A Mono where, upon successful completion, emits the Guild the messages where deleted from. If an error is received, it is emitted through the Mono.

toString

public String toString()

Overrides:

toString in class Object