discord4j.core.event.domain.message

Class ReactionAddEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.message.MessageEvent

discord4j.core.event.domain.message.ReactionAddEvent

public class ReactionAddEvent
extends MessageEvent

Dispatched when a reaction is added to a message.

guildId may not be present if the message was in a private channel.

This event is dispatched by Discord.

See Also:

Message Reaction Add

Constructor Summary

Constructors

Constructor and Description
ReactionAddEvent(DiscordClient client, long userId, long channelId, long messageId, Long guildId, ReactionEmoji emoji)

Method Summary

Modifier and Type	Method and Description
Mono<MessageChannel>	getChannel() Requests to retrieve the MessageChannel the Message and reaction are in.
Snowflake	getChannelId() Gets the Snowflake ID of the MessageChannel the Message and reaction are in.
ReactionEmoji	getEmoji() Gets the ReactionEmoji that was added to the Message in this event.
Mono<Guild>	getGuild() Request to retrieve the Guild containing the Message and reaction, if present.
Optional<Snowflake>	getGuildId() Gets the Snowflake ID of the Guild containing the Message and Reaction, if present.
Mono<Message>	getMessage() Request to retrieve the Message the reaction was added to in this event.
Snowflake	getMessageId() Gets the Snowflake ID of the Message the reaction was added to in this event.
Mono<User>	getUser() Requests to retrieve the User who added a reaction in this event.
Snowflake	getUserId() Gets the Snowflake ID of the User who added a reaction in this event.
String	toString()

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

getClient

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactionAddEvent

public ReactionAddEvent(DiscordClient client,
                        long userId,
                        long channelId,
                        long messageId,
                        @Nullable
                        Long guildId,
                        ReactionEmoji emoji)

Method Detail

getUserId

public Snowflake getUserId()

Gets the Snowflake ID of the User who added a reaction in this event.

Returns:

The Id of the User who added a reaction.

getUser

public Mono<User> getUser()

Requests to retrieve the User who added a reaction in this event.

Returns:

A Mono where, upon successful completion, emits the User that has added the reaction. If an error is received, it is emitted through the Mono.

getChannelId

public Snowflake getChannelId()

Gets the Snowflake ID of the MessageChannel the Message and reaction are in.

Returns:

The ID of the MessageChannel involved.

getChannel

public Mono<MessageChannel> getChannel()

Requests to retrieve the MessageChannel the Message and reaction are in.

Returns:

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

getMessageId

public Snowflake getMessageId()

Gets the Snowflake ID of the Message the reaction was added to in this event.

Returns:

The ID of the Message the reaction was added to.

getMessage

public Mono<Message> getMessage()

Request to retrieve the Message the reaction was added to in this event.

Returns:

A Mono where, upon successful completion, emits the Message the reaction was added to. If an error is received, it is emitted through the Mono.

getGuildId

public Optional<Snowflake> getGuildId()

Gets the Snowflake ID of the Guild containing the Message and Reaction, if present. This may not be available if the reaction is to a Message in a private channel.

Returns:

The ID of the Guild involved in the event, if present.

getGuild

public Mono<Guild> getGuild()

Request to retrieve the Guild containing the Message and reaction, if present. This may not be available if the reaction is to a Message in a private channel.

Returns:

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

getEmoji

public ReactionEmoji getEmoji()

Gets the ReactionEmoji that was added to the Message in this event.

Returns:

The Emoji added to the Message as a reaction.

toString

public String toString()

Overrides:

toString in class Object