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

Class PlainTextInputElement

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

  • Field Details

  • Constructor Details

  • Method Details

    • builder

      public static PlainTextInputElement.PlainTextInputElementBuilder builder()

    • getType

      public String getType()

    • getActionId

      public String getActionId()
      An identifier for the input value when the parent modal is submitted. You can use this when you receive a view_submission payload to identify the value of the input element. Should be unique among all other action_ids used elsewhere by your app. Maximum length for this field is 255 characters.

    • getPlaceholder

      public PlainTextObject getPlaceholder()
      A plain_text only text object that defines the placeholder text shown in the plain-text input. Maximum length for the text in this field is 150 characters.

    • getInitialValue

      public String getInitialValue()
      The initial value in the plain-text input when it is loaded.

    • isMultiline

      public boolean isMultiline()
      Indicates whether the input will be a single line (false) or a larger textarea (true). Defaults to false.

    • getMinLength

      public Integer getMinLength()
      The minimum length of input that the user must provide. If the user provides less, they will receive an error. Maximum value is 3000.

    • getMaxLength

      public Integer getMaxLength()
      The maximum length of input that the user can provide. If the user provides more, they will receive an error.

    • getDispatchActionConfig

      public DispatchActionConfig getDispatchActionConfig()
      A dispatch configuration object that determines when during text input the element returns a block_actions payload.

    • 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 input value when the parent modal is submitted. You can use this when you receive a view_submission payload to identify the value of the input element. Should be unique among all other action_ids used elsewhere by your app. Maximum length for this field is 255 characters.

    • setPlaceholder

      public void setPlaceholder(PlainTextObject placeholder)
      A plain_text only text object that defines the placeholder text shown in the plain-text input. Maximum length for the text in this field is 150 characters.

    • setInitialValue

      public void setInitialValue(String initialValue)
      The initial value in the plain-text input when it is loaded.

    • setMultiline

      public void setMultiline(boolean multiline)
      Indicates whether the input will be a single line (false) or a larger textarea (true). Defaults to false.

    • setMinLength

      public void setMinLength(Integer minLength)
      The minimum length of input that the user must provide. If the user provides less, they will receive an error. Maximum value is 3000.

    • setMaxLength

      public void setMaxLength(Integer maxLength)
      The maximum length of input that the user can provide. If the user provides more, they will receive an error.

    • setDispatchActionConfig

      public void setDispatchActionConfig(DispatchActionConfig dispatchActionConfig)
      A dispatch configuration object that determines when during text input the element returns a block_actions payload.

    • 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