com.jesus_crie.modularbot.messagedecorator.button

Class EmoteDecoratorButton

java.lang.Object

com.jesus_crie.modularbot.messagedecorator.button.DecoratorButton

com.jesus_crie.modularbot.messagedecorator.button.EmoteDecoratorButton

All Implemented Interfaces:

Cacheable

public class EmoteDecoratorButton
extends DecoratorButton

Field Summary

Fields inherited from class com.jesus_crie.modularbot.messagedecorator.button.DecoratorButton

onTrigger

Fields inherited from interface com.jesus_crie.modularbot.messagedecorator.Cacheable

KEY_ACTION_FUNCTIONAL, KEY_ACTION_SCRIPT, KEY_BINDING_CHANNEL_ID, KEY_BINDING_ID, KEY_CLASS, KEY_CLASS_UNDERLYING, KEY_DELETE_AFTER, KEY_EMOTE, KEY_POLL_VOTE_ACTION, KEY_POLL_VOTES, KEY_TIMEOUT, KEY_TIMEOUT_ACTION

Constructor Summary

Constructors

Constructor and Description
EmoteDecoratorButton(net.dv8tion.jda.core.entities.Emote emote, com.jesus_crie.modularbot.core.utils.SerializableConsumer<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent> onTrigger)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkEmote(net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent event) Used to check if an is eligible for this button.
java.lang.String	getEmoteSerialized() Return a serialized version of the emote corresponding to this button.
net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote	getReactionEmote() Get a ReactionEmote representing the associated emote.
net.dv8tion.jda.core.requests.RestAction<java.lang.Void>	removeEmote(net.dv8tion.jda.core.entities.Message target) Called when the decorator is destroying and need to remove the reactions.
net.dv8tion.jda.core.requests.RestAction<java.lang.Void>	setupEmote(net.dv8tion.jda.core.entities.Message target) Called when the decorator is initializing.

Methods inherited from class com.jesus_crie.modularbot.messagedecorator.button.DecoratorButton

fromReactionEmote, getActionSerializable, onTrigger, serialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jesus_crie.modularbot.messagedecorator.Cacheable

deserializeReactionEmote, getBinding

Constructor Detail

EmoteDecoratorButton

public EmoteDecoratorButton(@Nonnull
                            net.dv8tion.jda.core.entities.Emote emote,
                            @Nullable
                            com.jesus_crie.modularbot.core.utils.SerializableConsumer<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent> onTrigger)

Method Detail

setupEmote

@Nonnull
public net.dv8tion.jda.core.requests.RestAction<java.lang.Void> setupEmote(@Nonnull
                                                                                    net.dv8tion.jda.core.entities.Message target)

Description copied from class: DecoratorButton

Called when the decorator is initializing. Used to add the desired emote to the message.

Specified by:

setupEmote in class DecoratorButton

Parameters:

target - The target message.

Returns:

A RestAction that will add the emote to the message when executed.

removeEmote

@Nonnull
public net.dv8tion.jda.core.requests.RestAction<java.lang.Void> removeEmote(@Nonnull
                                                                                     net.dv8tion.jda.core.entities.Message target)

Description copied from class: DecoratorButton

Called when the decorator is destroying and need to remove the reactions.

Specified by:

removeEmote in class DecoratorButton

Parameters:

target - The target message.

Returns:

A RestAction that will remove the emote from the target message.

checkEmote

protected boolean checkEmote(@Nonnull
                             net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent event)

Description copied from class: DecoratorButton

Used to check if an is eligible for this button.

Specified by:

checkEmote in class DecoratorButton

Parameters:

event - The event to check.

Returns:

True if the event can be handle by this button, otherwise false.

getEmoteSerialized

@Nonnull
public java.lang.String getEmoteSerialized()

Description copied from class: DecoratorButton

Return a serialized version of the emote corresponding to this button.

Specified by:

getEmoteSerialized in class DecoratorButton

Returns:

A string representing the associated emote.

getReactionEmote

@Nonnull
public net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote getReactionEmote()

Description copied from class: DecoratorButton

Get a ReactionEmote representing the associated emote.

Specified by:

getReactionEmote in class DecoratorButton

Returns:

The associated emote as a ReactionEmote.