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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPlainTextInputElement.PlainTextInputElementBuilder
-
Constructor Summary
Constructors Constructor Description PlainTextInputElement()PlainTextInputElement(String actionId, PlainTextObject placeholder, String initialValue, boolean multiline, Integer minLength, Integer maxLength, DispatchActionConfig dispatchActionConfig, Boolean focusOnLoad)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PlainTextInputElement.PlainTextInputElementBuilderbuilder()protected booleancanEqual(Object other)booleanequals(Object o)StringgetActionId()An identifier for the input value when the parent modal is submitted.DispatchActionConfiggetDispatchActionConfig()A dispatch configuration object that determines when during text input the element returns a block_actions payload.BooleangetFocusOnLoad()Indicates whether the element will be set to auto focus within the view object.StringgetInitialValue()The initial value in the plain-text input when it is loaded.IntegergetMaxLength()The maximum length of input that the user can provide.IntegergetMinLength()The minimum length of input that the user must provide.PlainTextObjectgetPlaceholder()A plain_text only text object that defines the placeholder text shown in the plain-text input.StringgetType()inthashCode()booleanisMultiline()Indicates whether the input will be a single line (false) or a larger textarea (true).voidsetActionId(String actionId)An identifier for the input value when the parent modal is submitted.voidsetDispatchActionConfig(DispatchActionConfig dispatchActionConfig)A dispatch configuration object that determines when during text input the element returns a block_actions payload.voidsetFocusOnLoad(Boolean focusOnLoad)Indicates whether the element will be set to auto focus within the view object.voidsetInitialValue(String initialValue)The initial value in the plain-text input when it is loaded.voidsetMaxLength(Integer maxLength)The maximum length of input that the user can provide.voidsetMinLength(Integer minLength)The minimum length of input that the user must provide.voidsetMultiline(boolean multiline)Indicates whether the input will be a single line (false) or a larger textarea (true).voidsetPlaceholder(PlainTextObject placeholder)A plain_text only text object that defines the placeholder text shown in the plain-text input.StringtoString()
-
-
-
Field Detail
-
TYPE
public static final String TYPE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PlainTextInputElement
public PlainTextInputElement()
-
PlainTextInputElement
public PlainTextInputElement(String actionId, PlainTextObject placeholder, String initialValue, boolean multiline, Integer minLength, Integer maxLength, DispatchActionConfig dispatchActionConfig, Boolean focusOnLoad)
-
-
Method Detail
-
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.
-
canEqual
protected boolean canEqual(Object other)
-
-