Package discord4j.core.event.domain.message

Class MessageDeleteEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.message.MessageEvent

discord4j.core.event.domain.message.MessageDeleteEvent

public class MessageDeleteEvent
extends MessageEvent

Dispatched when a message is deleted.

The deleted message may not be present if messages are not stored.

This event is dispatched by Discord.

See Also:

Message Delete

Constructor Summary

Constructors

Constructor	Description
MessageDeleteEvent(GatewayDiscordClient gateway, ShardInfo shardInfo, long messageId, long channelId, Long guildId, Message message)

Method Summary

Modifier and Type	Method	Description
Mono<MessageChannel>	getChannel()	Requests to retrieve the MessageChannel the Message was deleted from.
Snowflake	getChannelId()	Gets the Snowflake ID of the MessageChannel the Message was deleted from.
Mono<Guild>	getGuild()	Requests to retrieve the Guild the Message was deleted from, if present.
Optional<Snowflake>	getGuildId()	Gets the Snowflake ID of the Guild the Message was deleted from, if present.
Optional<Message>	getMessage()	Gets the Message that was deleted in this event, if present.
Snowflake	getMessageId()	Gets the Snowflake ID of the Message that was deleted.
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

MessageDeleteEvent

public MessageDeleteEvent(GatewayDiscordClient gateway,
                          ShardInfo shardInfo,
                          long messageId,
                          long channelId,
                          @Nullable
                          Long guildId,
                          @Nullable
                          Message message)

Method Detail

getMessageId

public Snowflake getMessageId()

Gets the Snowflake ID of the Message that was deleted.

Returns:

The ID of the deleted Message.

getMessage

public Optional<Message> getMessage()

Gets the Message that was deleted in this event, if present. This may not be available if Messages are not stored.

Returns:

The deleted Message, if present.

getChannelId

public Snowflake getChannelId()

Gets the Snowflake ID of the MessageChannel the Message was deleted from.

Returns:

The ID of the MessageChannel that the Message was deleted from.

getChannel

public Mono<MessageChannel> getChannel()

Requests to retrieve the MessageChannel the Message was deleted from.

Returns:

A Mono where, upon successful completion, emits the MessageChannel the Message was deleted in. If an error is received, it is emitted through the Mono.

getGuildId

public Optional<Snowflake> getGuildId()

Gets the Snowflake ID of the Guild the Message was deleted from, if present. This may not be available if the deleted Message was from a private channel.

Returns:

The ID of the Guild involved, if present.

getGuild

public Mono<Guild> getGuild()

Requests to retrieve the Guild the Message was deleted from, if present. This may not be available if the deleted Message was from a private channel.

Returns:

A Mono where, upon successful completion, emits the Guild that contained the Message involved, if present. If an error is received, it is emitted through the Mono.

toString

public String toString()

Overrides:

toString in class Object