com.jesus_crie.modularbot.messagedecorator.decorator.permanent

Class PollReactionDecorator

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.permanent.PermanentReactionDecorator

com.jesus_crie.modularbot.messagedecorator.decorator.permanent.PollReactionDecorator

All Implemented Interfaces:

Cacheable

public class PollReactionDecorator
extends PermanentReactionDecorator
implements Cacheable

A persistent decorator that can retrieve the amount of the desired emotes under a specific message, like a poll. It will collect only the emote that are specified in the constructor that are added during the setup.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.jesus_crie.modularbot.core.utils.SerializableConsumer<PollReactionDecorator>	onTimeout
protected com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<PollReactionDecorator,net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent>	onVote

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

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
PollReactionDecorator(net.dv8tion.jda.core.entities.Message binding, long timeout, com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<PollReactionDecorator,net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent> onVote, com.jesus_crie.modularbot.core.utils.SerializableConsumer<PollReactionDecorator> onTimeout, net.dv8tion.jda.core.entities.Emote... emotes) Constructor that allows only custom server emotes for votes.
PollReactionDecorator(net.dv8tion.jda.core.entities.Message binding, long timeout, com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<PollReactionDecorator,net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent> onVote, com.jesus_crie.modularbot.core.utils.SerializableConsumer<PollReactionDecorator> onTimeout, net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote... votes) Create a poll decorator using ReactionEmote for the votes.
PollReactionDecorator(net.dv8tion.jda.core.entities.Message binding, long timeout, com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<PollReactionDecorator,net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent> onVote, com.jesus_crie.modularbot.core.utils.SerializableConsumer<PollReactionDecorator> onTimeout, java.lang.String... emotes) Constructor that allows only unicode emotes for votes.

Method Summary

Modifier and Type	Method and Description
java.util.Map<net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote,java.lang.Integer>	collectVotes() Request the emotes under the message and count them, minus one for the base reaction.
java.util.Map<java.lang.String,java.lang.Integer>	collectVotesByName() Same as collectVotes() but the key will be the name of the emote (or the unicode character).
protected void	onTimeout() Triggered when the decorator times out.
protected boolean	onTrigger(net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent event) Called when the decorator is triggered.
com.electronwill.nightconfig.core.Config	serialize() Used to serialize the object into a Config usable by the config module.
static PollReactionDecorator	tryDeserialize(com.electronwill.nightconfig.core.Config serialized, com.jesus_crie.modularbot.core.ModularBot bot) Try to convert a Config into a poll decorator.

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

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

deserializeReactionEmote, getBinding

Field Detail

onVote

protected final com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<PollReactionDecorator,net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent> onVote

onTimeout

protected final com.jesus_crie.modularbot.core.utils.SerializableConsumer<PollReactionDecorator> onTimeout

Constructor Detail

PollReactionDecorator

public PollReactionDecorator(@Nonnull
                             net.dv8tion.jda.core.entities.Message binding,
                             long timeout,
                             @Nullable
                             com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<PollReactionDecorator,net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent> onVote,
                             @Nullable
                             com.jesus_crie.modularbot.core.utils.SerializableConsumer<PollReactionDecorator> onTimeout,
                             @Nonnull
                             net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote... votes)

Create a poll decorator using ReactionEmote for the votes.

Parameters:

binding - The bound message.

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

onVote - (Optional) The action to perform when a vote is added or removed.

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

votes - The emotes that corresponds at the votes that will be counted by the decorator.

PollReactionDecorator

public PollReactionDecorator(@Nonnull
                             net.dv8tion.jda.core.entities.Message binding,
                             long timeout,
                             @Nullable
                             com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<PollReactionDecorator,net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent> onVote,
                             @Nullable
                             com.jesus_crie.modularbot.core.utils.SerializableConsumer<PollReactionDecorator> onTimeout,
                             @Nonnull
                             java.lang.String... emotes)

Constructor that allows only unicode emotes for votes.

Parameters:

binding - The bound message.

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

onVote - (Optional) The action to perform when a vote is added or removed.

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

emotes - The unicode emotes that will be used for votes.

PollReactionDecorator

public PollReactionDecorator(@Nonnull
                             net.dv8tion.jda.core.entities.Message binding,
                             long timeout,
                             @Nullable
                             com.jesus_crie.modularbot.core.utils.SerializableBiConsumer<PollReactionDecorator,net.dv8tion.jda.core.events.message.react.GenericMessageReactionEvent> onVote,
                             @Nullable
                             com.jesus_crie.modularbot.core.utils.SerializableConsumer<PollReactionDecorator> onTimeout,
                             @Nonnull
                             net.dv8tion.jda.core.entities.Emote... emotes)

Constructor that allows only custom server emotes for votes.

Parameters:

binding - The bound message.

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

onVote - (Optional) The action to perform when a vote is added or removed.

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

emotes - The custom emotes that will be used for votes.

Method Detail

onTrigger

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

Description copied from class: ReactionDecorator

Called when the decorator is triggered.

Overrides:

onTrigger in class ReactionDecorator

Parameters:

event - The event that was thrown.

Returns:

True if the event has triggered a button, otherwise false.

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 ReactionDecorator

collectVotes

@Nonnull
public java.util.Map<net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote,java.lang.Integer> collectVotes()

Request the emotes under the message and count them, minus one for the base reaction. Calling this method too often can be costly since the message is queried from discord each time.

Returns:

A map containing the votes present on the bound message.

collectVotesByName

@Nonnull
public java.util.Map<java.lang.String,java.lang.Integer> collectVotesByName()

Same as collectVotes() but the key will be the name of the emote (or the unicode character).

Returns:

A map containing the votes present on the bound message.

tryDeserialize

@Nullable
public static PollReactionDecorator tryDeserialize(@Nonnull
                                                             com.electronwill.nightconfig.core.Config serialized,
                                                             @Nonnull
                                                             com.jesus_crie.modularbot.core.ModularBot bot)

Try to convert a Config into a poll decorator.

Parameters:

serialized - The serialized version of the decorator.

bot - The current instance of the bot.

Returns:

The deserialized PollReactionDecorator or null if it wasn't valid anymore.

Throws:

java.lang.IllegalArgumentException - If a required field is missing.

java.lang.IllegalStateException - If the binding can't be retrieved (usually it's deleted)

serialize

@Nonnull
public com.electronwill.nightconfig.core.Config serialize()

Description copied from interface: Cacheable

Used to serialize the object into a Config usable by the config module.

Specified by:

serialize in interface Cacheable

Returns:

A Config containing the information necessary to restore the object.