Package com.jagrosh.jdautilities.menu

Class SelectionDialog

java.lang.Object
com.jagrosh.jdautilities.menu.Menu
com.jagrosh.jdautilities.menu.SelectionDialog
public class SelectionDialog extends Menu
A Menu implementation that creates a listed display of text choices horizontally that users can scroll through using reactions and make selections.
Author:
John Grosh

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    SelectionDialog.Builder
    The Menu.Builder for a SelectuibDialog.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CANCEL
     
    static final String
    DOWN
     
    static final String
    SELECT
     
    static final String
    UP
     

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

    roles, timeout, unit, users, waiter

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    display(net.dv8tion.jda.api.entities.Message message)
    Displays this SelectionDialog by editing the provided Message, starting with the first selection.
    void
    display(net.dv8tion.jda.api.entities.MessageChannel channel)
    Shows the SelectionDialog as a new Message in the provided MessageChannel, starting with the first selection.
    void
    showDialog(net.dv8tion.jda.api.entities.MessageChannel channel, int selection)
    Shows the SelectionDialog as a new Message in the provided MessageChannel, starting with the number selection provided.
    void
    showDialog(net.dv8tion.jda.api.entities.Message message, int selection)
    Displays this SelectionDialog by editing the provided Message, starting with the number selection provided.

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

    isValidUser, isValidUser

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Method Details

    • display

      public void display(net.dv8tion.jda.api.entities.MessageChannel channel)
      Shows the SelectionDialog as a new Message in the provided MessageChannel, starting with the first selection.
      Specified by:
      display in class Menu
      Parameters:
      channel - The MessageChannel to send the new Message to

    • display

      public void display(net.dv8tion.jda.api.entities.Message message)
      Displays this SelectionDialog by editing the provided Message, starting with the first selection.
      Specified by:
      display in class Menu
      Parameters:
      message - The Message to display the Menu in

    • showDialog

      public void showDialog(net.dv8tion.jda.api.entities.MessageChannel channel, int selection)
      Shows the SelectionDialog as a new Message in the provided MessageChannel, starting with the number selection provided.
      Parameters:
      channel - The MessageChannel to send the new Message to
      selection - The number selection to start on

    • showDialog

      public void showDialog(net.dv8tion.jda.api.entities.Message message, int selection)
      Displays this SelectionDialog by editing the provided Message, starting with the number selection provided.
      Parameters:
      message - The Message to display the Menu in
      selection - The number selection to start on