com.jesus_crie.modularbot.messagedecorator.decorator.disposable

Class ConfirmReactionDecorator

java.lang.Object

com.jesus_crie.modularbot.messagedecorator.decorator.MessageDecorator<net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent>

com.jesus_crie.modularbot.messagedecorator.decorator.ReactionDecorator

com.jesus_crie.modularbot.messagedecorator.decorator.disposable.DisposableReactionDecorator

com.jesus_crie.modularbot.messagedecorator.decorator.disposable.AutoDeleteDisposableReactionDecorator

com.jesus_crie.modularbot.messagedecorator.decorator.disposable.SafeAutoDestroyDisposableReactionDecorator

com.jesus_crie.modularbot.messagedecorator.decorator.disposable.ConfirmReactionDecorator

public class ConfirmReactionDecorator
extends SafeAutoDestroyDisposableReactionDecorator

Field Summary

Fields

Modifier and Type	Field and Description
static net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote	DEFAULT_NO_EMOTE The default "no" emote.
static net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote	DEFAULT_YES_EMOTE The default "yes" emote.

Fields inherited from class com.jesus_crie.modularbot.messagedecorator.decorator.disposable.SafeAutoDestroyDisposableReactionDecorator

deleteAfter

Fields inherited from class com.jesus_crie.modularbot.messagedecorator.decorator.ReactionDecorator

buttons

Fields inherited from class com.jesus_crie.modularbot.messagedecorator.decorator.MessageDecorator

binding, creationTime, isAlive, listener, listeners, timeout

Constructor Summary

Constructors

Constructor and Description
ConfirmReactionDecorator(net.dv8tion.jda.core.entities.Message binding, long timeout, DecoratorButton yesButton, DecoratorButton noButton, com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onTimeout, boolean deleteAfter) Create a confirm decorator with custom buttons.
ConfirmReactionDecorator(net.dv8tion.jda.core.entities.Message binding, long timeout, net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote yesEmote, net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote noEmote, com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<ConfirmReactionDecorator,java.lang.Boolean> onTrigger, com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onTimeout, boolean deleteAfter) Create a confirm decorator with custom emotes and a common action for both buttons.
ConfirmReactionDecorator(net.dv8tion.jda.core.entities.Message binding, long timeout, com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<ConfirmReactionDecorator,java.lang.Boolean> onTrigger, com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onTimeout, boolean deleteAfter) Create a confirm decorator with the default emotes and a common action for both buttons.
ConfirmReactionDecorator(net.dv8tion.jda.core.entities.Message binding, long timeout, com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onYes, com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onNo, com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onTimeout, boolean deleteAfter) Create a confirm decorator with the default emotes and custom actions for each choice.

Method Summary

Modifier and Type	Method and Description
protected void	onTimeout() Triggered when the decorator times out.

Methods inherited from class com.jesus_crie.modularbot.messagedecorator.decorator.disposable.AutoDeleteDisposableReactionDecorator

onTrigger

Methods inherited from class com.jesus_crie.modularbot.messagedecorator.decorator.ReactionDecorator

createListener, destroy, destroyButtons, setup

Methods inherited from class com.jesus_crie.modularbot.messagedecorator.decorator.MessageDecorator

checkTimeout, equals, getBinding, getExpireTime, isAlive, register, register, toString, updateMessage

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_YES_EMOTE

public static final net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote DEFAULT_YES_EMOTE

The default "yes" emote. Correspond to the unicode character "✅".

DEFAULT_NO_EMOTE

public static final net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote DEFAULT_NO_EMOTE

The default "no" emote. Corresponds to the unicode character "❎".

Constructor Detail

ConfirmReactionDecorator

public ConfirmReactionDecorator(@Nonnull
                                net.dv8tion.jda.core.entities.Message binding,
                                long timeout,
                                @Nonnull
                                com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onYes,
                                @Nullable
                                com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onNo,
                                @Nullable
                                com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onTimeout,
                                boolean deleteAfter)

Create a confirm decorator with the default emotes and custom actions for each choice.

Parameters:

binding - The bound message.

timeout - The amount of time in milliseconds before the decorator times out, or 0 for infinite.

onYes - The action to perform when the "yes" button is triggered.

onNo - (Optional) The action to perform when the "no" button is triggered.

onTimeout - (Optional) The action to perform when the decorator times out.

deleteAfter - Whether the message should be deleted when the decorator is being destroyed.

ConfirmReactionDecorator

public ConfirmReactionDecorator(@Nonnull
                                net.dv8tion.jda.core.entities.Message binding,
                                long timeout,
                                @Nonnull
                                com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<ConfirmReactionDecorator,java.lang.Boolean> onTrigger,
                                @Nullable
                                com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onTimeout,
                                boolean deleteAfter)

Create a confirm decorator with the default emotes and a common action for both buttons.

Parameters:

binding - The bound message.

timeout - The amount of time in milliseconds before the decorator times out, or 0 for infinite.

onTrigger - The action to perform when one of the buttons is triggered.

onTimeout - The action to perform when the decorator times out.

deleteAfter - Whether the message should be deleted when the decorator is being destroyed.

ConfirmReactionDecorator

public ConfirmReactionDecorator(@Nonnull
                                net.dv8tion.jda.core.entities.Message binding,
                                long timeout,
                                @Nonnull
                                net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote yesEmote,
                                @Nonnull
                                net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote noEmote,
                                @Nonnull
                                com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<ConfirmReactionDecorator,java.lang.Boolean> onTrigger,
                                @Nullable
                                com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onTimeout,
                                boolean deleteAfter)

Create a confirm decorator with custom emotes and a common action for both buttons.

Parameters:

binding - The bound message.

timeout - The amount of time in milliseconds before the decorator times out, or 0 for infinite.

yesEmote - The emote for the "yes" button.

noEmote - The emote for the "no" button.

onTrigger - The action to trigger when one of the buttons is triggered.

onTimeout - The action to perform when the decorator times out.

deleteAfter - Whether the message should be deleted when the decorator is being destroyed.

ConfirmReactionDecorator

public ConfirmReactionDecorator(@Nonnull
                                net.dv8tion.jda.core.entities.Message binding,
                                long timeout,
                                @Nonnull
                                DecoratorButton yesButton,
                                @Nonnull
                                DecoratorButton noButton,
                                @Nullable
                                com.jesus_crie.modularbot.core.utils.SerializableConsumer<ConfirmReactionDecorator> onTimeout,
                                boolean deleteAfter)

Create a confirm decorator with custom buttons.

Parameters:

binding - The bound message.

timeout - The amount of time in milliseconds before the decorator times out, or 0 for infinite.

yesButton - The "yes" button and its action.

noButton - The "no" button and its action.

onTimeout - The action to perform when the decorator times out.

deleteAfter - Whether the message should be deleted when the decorator is being destroyed.

Method Detail

onTimeout

protected void onTimeout()

Description copied from class: MessageDecorator

Triggered when the decorator times out. If this method isn't overridden, it will throw an exception but this method isn't called by default.

On the other hand, an implementation like ReactionDecorator will call MessageDecorator.destroy() on timeout which is an expected behaviour.

Overrides:

onTimeout in class SafeAutoDestroyDisposableReactionDecorator