com.jagrosh.jdautilities.menu

Class ButtonMenu.Builder

java.lang.Object

com.jagrosh.jdautilities.menu.Menu.Builder<ButtonMenu.Builder,ButtonMenu>

com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Enclosing class:

ButtonMenu

public static class ButtonMenu.Builder
extends Menu.Builder<ButtonMenu.Builder,ButtonMenu>

The Menu.Builder for a ButtonMenu.

Author:

John Grosh

Field Summary

Fields inherited from class com.jagrosh.jdautilities.menu.Menu.Builder

roles, timeout, unit, users, waiter

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ButtonMenu.Builder	addChoice(net.dv8tion.jda.core.entities.Emote emote) Adds a single custom Emote as button choices.
ButtonMenu.Builder	addChoice(java.lang.String emoji) Adds a single String unicode emoji as a button choice.
ButtonMenu.Builder	addChoices(net.dv8tion.jda.core.entities.Emote... emotes) Adds custom Emotes as button choices.
ButtonMenu.Builder	addChoices(java.lang.String... emojis) Adds String unicode emojis as button choices.
ButtonMenu	build() Builds the ButtonMenu with this Builder.
ButtonMenu.Builder	setAction(java.util.function.Consumer<net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote> action) Sets the Consumer action to perform upon selecting a button.
ButtonMenu.Builder	setChoices(net.dv8tion.jda.core.entities.Emote... emotes) Sets the Emotes as button choices.
ButtonMenu.Builder	setChoices(java.lang.String... emojis) Sets the String unicode emojis as button choices.
ButtonMenu.Builder	setColor(java.awt.Color color) Sets the Color of the MessageEmbed.
ButtonMenu.Builder	setDescription(java.lang.String description) Sets the description to be placed in an MessageEmbed.
ButtonMenu.Builder	setFinalAction(java.util.function.Consumer<net.dv8tion.jda.core.entities.Message> finalAction) Sets the Consumer to perform if the ButtonMenu is done, either via cancellation, a timeout, or a selection being made.
ButtonMenu.Builder	setText(java.lang.String text) Sets the text of the Message to be displayed when the ButtonMenu is built.

Methods inherited from class com.jagrosh.jdautilities.menu.Menu.Builder

addRoles, addUsers, setEventWaiter, setRoles, setTimeout, setUsers

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public ButtonMenu build()

Builds the ButtonMenu with this Builder.

Specified by:

build in class Menu.Builder<ButtonMenu.Builder,ButtonMenu>

Returns:

The OrderedMenu built from this Builder.

Throws:

java.lang.IllegalArgumentException - If one of the following is violated:

• No EventWaiter was set.
• No choices were set.
• No action Consumer was set.
• Neither text nor description were set.

setColor

public ButtonMenu.Builder setColor(java.awt.Color color)

Sets the Color of the MessageEmbed.

Parameters:

color - The Color of the MessageEmbed

Returns:

This builder

setText

public ButtonMenu.Builder setText(java.lang.String text)

Sets the text of the Message to be displayed when the ButtonMenu is built.

This is displayed directly above the embed.

Parameters:

text - The Message content to be displayed above the embed when the ButtonMenu is built

Returns:

This builder

setDescription

public ButtonMenu.Builder setDescription(java.lang.String description)

Sets the description to be placed in an MessageEmbed.
If this is null, no MessageEmbed will be displayed

Parameters:

description - The content of the MessageEmbed's description

Returns:

This builder

setAction

public ButtonMenu.Builder setAction(java.util.function.Consumer<net.dv8tion.jda.core.entities.MessageReaction.ReactionEmote> action)

Sets the Consumer action to perform upon selecting a button.

Parameters:

action - The Consumer action to perform upon selecting a button

Returns:

This builder

setFinalAction

public ButtonMenu.Builder setFinalAction(java.util.function.Consumer<net.dv8tion.jda.core.entities.Message> finalAction)

Sets the Consumer to perform if the ButtonMenu is done, either via cancellation, a timeout, or a selection being made.

This accepts the message used to display the menu when called.

Parameters:

finalAction - The Runnable action to perform if the ButtonMenu is done

Returns:

This builder

addChoice

public ButtonMenu.Builder addChoice(java.lang.String emoji)

Adds a single String unicode emoji as a button choice.

Any non-unicode Emote should be added using ButtonMenu.Builder#addChoice(Emote).

Parameters:

emoji - The String unicode emoji to add

Returns:

This builder

addChoice

public ButtonMenu.Builder addChoice(net.dv8tion.jda.core.entities.Emote emote)

Adds a single custom Emote as button choices.

Any regular unicode emojis should be added using ButtonMenu.Builder#addChoice(String).

Parameters:

emote - The Emote object to add

Returns:

This builder

addChoices

public ButtonMenu.Builder addChoices(java.lang.String... emojis)

Adds String unicode emojis as button choices.

Any non-unicode Emotes should be added using ButtonMenu.Builder#addChoices(Emote...).

Parameters:

emojis - The String unicode emojis to add

Returns:

This builder

addChoices

public ButtonMenu.Builder addChoices(net.dv8tion.jda.core.entities.Emote... emotes)

Adds custom Emotes as button choices.

Any regular unicode emojis should be added using ButtonMenu.Builder#addChoices(String...).

Parameters:

emotes - The Emote objects to add

Returns:

This builder

setChoices

public ButtonMenu.Builder setChoices(java.lang.String... emojis)

Sets the String unicode emojis as button choices.

Any non-unicode Emotes should be set using ButtonMenu.Builder#setChoices(Emote...).

Parameters:

emojis - The String unicode emojis to set

Returns:

This builder

setChoices

public ButtonMenu.Builder setChoices(net.dv8tion.jda.core.entities.Emote... emotes)

Sets the Emotes as button choices.

Any regular unicode emojis should be set using ButtonMenu.Builder#setChoices(String...).

Parameters:

emotes - The Emote objects to set

Returns:

This builder