Package com.slack.api.model.block

Class InputBlock

java.lang.Object
com.slack.api.model.block.InputBlock
All Implemented Interfaces:
LayoutBlock
public class InputBlock extends Object implements LayoutBlock
https://docs.slack.dev/reference/block-kit/blocks/input-block

  • Field Details

  • Constructor Details

    • InputBlock

      public InputBlock()

    • InputBlock

      public InputBlock(String blockId, PlainTextObject label, BlockElement element, Boolean dispatchAction, PlainTextObject hint, boolean optional)
      Creates a new InputBlock instance.
      Parameters:
      blockId -
      label - A label that appears above an input element in the form of a text object that must have type of plain_text. Maximum length for the text in this field is 2000 characters.
      element - A plain-text input element, a select menu element, a multi-select menu, or a datepicker element.
      dispatchAction - A boolean that indicates whether or not use of element in this block should dispatch a block_actions payload. Defaults to false.
      hint - An optional hint that appears below an input element in a lighter grey. It must be a text object with a type of plain_text. Maximum length for the text in this field is 2000 characters.
      optional - A boolean that indicates whether the input element may be empty when a user submits the modal. Defaults to false.

  • Method Details

    • builder

      public static InputBlock.InputBlockBuilder builder()

    • getType

      public String getType()
      Description copied from interface: LayoutBlock
      Determines the type of layout block, e.g. section, divider, context, actions and image.
      Specified by:
      getType in interface LayoutBlock

    • getBlockId

      public String getBlockId()
      Description copied from interface: LayoutBlock
      Returns the block_id string; the value can be null if the object is manually crafted.
      Specified by:
      getBlockId in interface LayoutBlock

    • getLabel

      public PlainTextObject getLabel()
      A label that appears above an input element in the form of a text object that must have type of plain_text. Maximum length for the text in this field is 2000 characters.

    • getElement

      public BlockElement getElement()
      A plain-text input element, a select menu element, a multi-select menu, or a datepicker element.

    • getDispatchAction

      public Boolean getDispatchAction()
      A boolean that indicates whether or not use of element in this block should dispatch a block_actions payload. Defaults to false.

    • getHint

      public PlainTextObject getHint()
      An optional hint that appears below an input element in a lighter grey. It must be a text object with a type of plain_text. Maximum length for the text in this field is 2000 characters.

    • isOptional

      public boolean isOptional()
      A boolean that indicates whether the input element may be empty when a user submits the modal. Defaults to false.

    • setBlockId

      public void setBlockId(String blockId)

    • setLabel

      public void setLabel(PlainTextObject label)
      A label that appears above an input element in the form of a text object that must have type of plain_text. Maximum length for the text in this field is 2000 characters.

    • setElement

      public void setElement(BlockElement element)
      A plain-text input element, a select menu element, a multi-select menu, or a datepicker element.

    • setDispatchAction

      public void setDispatchAction(Boolean dispatchAction)
      A boolean that indicates whether or not use of element in this block should dispatch a block_actions payload. Defaults to false.

    • setHint

      public void setHint(PlainTextObject hint)
      An optional hint that appears below an input element in a lighter grey. It must be a text object with a type of plain_text. Maximum length for the text in this field is 2000 characters.

    • setOptional

      public void setOptional(boolean optional)
      A boolean that indicates whether the input element may be empty when a user submits the modal. Defaults to false.

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object