Class PlainTextInputElement.PlainTextInputElementBuilder
java.lang.Object
com.slack.api.model.block.element.PlainTextInputElement.PlainTextInputElementBuilder
- Enclosing class:
- PlainTextInputElement
-
Method Summary
Modifier and TypeMethodDescriptionAn identifier for the input value when the parent modal is submitted.build()
dispatchActionConfig
(DispatchActionConfig dispatchActionConfig) A dispatch configuration object that determines when during text input the element returns a block_actions payload.focusOnLoad
(Boolean focusOnLoad) Indicates whether the element will be set to autofocus within the view object.initialValue
(String initialValue) The initial value in the plain-text input when it is loaded.The maximum length of input that the user can provide.The minimum length of input that the user must provide.multiline
(boolean multiline) Indicates whether the input will be a single line (false) or a larger textarea (true).placeholder
(PlainTextObject placeholder) A plain_text only text object that defines the placeholder text shown in the plain-text input.toString()
-
Method Details
-
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.- Returns:
this
.
-
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.- Returns:
this
.
-
initialValue
The initial value in the plain-text input when it is loaded.- Returns:
this
.
-
multiline
Indicates whether the input will be a single line (false) or a larger textarea (true). Defaults to false.- Returns:
this
.
-
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.- Returns:
this
.
-
maxLength
The maximum length of input that the user can provide. If the user provides more, they will receive an error.- Returns:
this
.
-
dispatchActionConfig
public PlainTextInputElement.PlainTextInputElementBuilder dispatchActionConfig(DispatchActionConfig dispatchActionConfig) A dispatch configuration object that determines when during text input the element returns a block_actions payload.- Returns:
this
.
-
focusOnLoad
Indicates whether the element will be set to autofocus within the view object. Only one element can be set to true. Defaults to false.- Returns:
this
.
-
build
-
toString
-