Class DialogSelectElement

  • All Implemented Interfaces:
    DialogElement

    public class DialogSelectElement
    extends Object
    implements DialogElement
    Represents a select dialog element

    Use the select element for multiple choice selections allowing users to pick a single item from a list. True to web roots, this selection is displayed as a dropdown menu.

    • Method Detail

      • getLabel

        public String getLabel()
        Label displayed to user. Required. No more than 24 characters.
        Specified by:
        getLabel in interface DialogElement
      • getName

        public String getName()
        Name of form element. Required. No more than 300 characters.
        Specified by:
        getName in interface DialogElement
      • getPlaceholder

        public String getPlaceholder()
        A string displayed as needed to help guide users in completing the element. 150 character maximum.
        Specified by:
        getPlaceholder in interface DialogElement
      • isOptional

        public boolean isOptional()
        Provide true when the form element is not required. By default, form elements are required.
        Specified by:
        isOptional in interface DialogElement
      • getOptions

        public List<DialogOption> getOptions()
        Provide up to 100 option element attributes. Either options or option_groups is required for the static and external.
      • getSelectedOptions

        public List<DialogOption> getSelectedOptions()
        Provide a default selected value for dynamic select menus with a data_source of type external.
      • getOptionGroups

        public List<DialogOptionGroup> getOptionGroups()
        Provide up to 100 option group element attributes. Either options or option_groups is required for the static and external.
      • getMinQueryLength

        public Integer getMinQueryLength()
        Provide the number of characters that must be typed by a user.
      • getDataSource

        public DialogDataSourceType getDataSource()
        Provide the data source type for the Element.
      • setLabel

        public void setLabel​(String label)
        Label displayed to user. Required. No more than 24 characters.
        Specified by:
        setLabel in interface DialogElement
      • setName

        public void setName​(String name)
        Name of form element. Required. No more than 300 characters.
        Specified by:
        setName in interface DialogElement
      • setPlaceholder

        public void setPlaceholder​(String placeholder)
        A string displayed as needed to help guide users in completing the element. 150 character maximum.
        Specified by:
        setPlaceholder in interface DialogElement
      • setOptional

        public void setOptional​(boolean optional)
        Provide true when the form element is not required. By default, form elements are required.
        Specified by:
        setOptional in interface DialogElement
      • setOptions

        public void setOptions​(List<DialogOption> options)
        Provide up to 100 option element attributes. Either options or option_groups is required for the static and external.
      • setSelectedOptions

        public void setSelectedOptions​(List<DialogOption> selectedOptions)
        Provide a default selected value for dynamic select menus with a data_source of type external.
      • setOptionGroups

        public void setOptionGroups​(List<DialogOptionGroup> optionGroups)
        Provide up to 100 option group element attributes. Either options or option_groups is required for the static and external.
      • setMinQueryLength

        public void setMinQueryLength​(Integer minQueryLength)
        Provide the number of characters that must be typed by a user.
      • setDataSource

        public void setDataSource​(DialogDataSourceType dataSource)
        Provide the data source type for the Element.
      • canEqual

        protected boolean canEqual​(Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object