Package com.slack.api.model.block.element

Class CheckboxesElement

java.lang.Object
com.slack.api.model.block.element.BlockElement
com.slack.api.model.block.element.CheckboxesElement
public class CheckboxesElement extends BlockElement
https://api.slack.com/reference/block-kit/block-elements#checkboxes

  • Field Details

  • Constructor Details

  • Method Details

    • builder

      public static CheckboxesElement.CheckboxesElementBuilder builder()

    • getType

      public String getType()

    • getActionId

      public String getActionId()
      An identifier for the action triggered when the checkbox group is changed. You can use this when you receive an interaction payload to identify the source of the action. Should be unique among all other action_ids used elsewhere by your app. Maximum length for this field is 255 characters.

    • getOptions

      public List<OptionObject> getOptions()
      An array of option objects.

      NOTE: The reason I didn't initialize the List<> fields is because Slack (sometimes) gives errors when it encounters an empty list in the generated JSON. The proper solution if/when you don't want un-initialized fields is to have a Gson type adapter that skips empty lists

      See Also:

    • getInitialOptions

      public List<OptionObject> getInitialOptions()
      An array of option objects that exactly matches one or more of the options within options. These options will be selected when the checkbox group initially loads.

    • getConfirm

      public ConfirmationDialogObject getConfirm()
      A confirm object that defines an optional confirmation dialog that appears after clicking one of the checkboxes in this element.

    • getFocusOnLoad

      public Boolean getFocusOnLoad()
      Indicates whether the element will be set to auto focus within the view object. Only one element can be set to true. Defaults to false.

    • setActionId

      public void setActionId(String actionId)
      An identifier for the action triggered when the checkbox group is changed. You can use this when you receive an interaction payload to identify the source of the action. Should be unique among all other action_ids used elsewhere by your app. Maximum length for this field is 255 characters.

    • setOptions

      public void setOptions(List<OptionObject> options)
      An array of option objects.

      NOTE: The reason I didn't initialize the List<> fields is because Slack (sometimes) gives errors when it encounters an empty list in the generated JSON. The proper solution if/when you don't want un-initialized fields is to have a Gson type adapter that skips empty lists

      See Also:

    • setInitialOptions

      public void setInitialOptions(List<OptionObject> initialOptions)
      An array of option objects that exactly matches one or more of the options within options. These options will be selected when the checkbox group initially loads.

    • setConfirm

      public void setConfirm(ConfirmationDialogObject confirm)
      A confirm object that defines an optional confirmation dialog that appears after clicking one of the checkboxes in this element.

    • setFocusOnLoad

      public void setFocusOnLoad(Boolean focusOnLoad)
      Indicates whether the element will be set to auto focus within the view object. Only one element can be set to true. Defaults to false.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object