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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlainTextInputElement.PlainTextInputElementBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
PlainTextInputElement()
PlainTextInputElement(String actionId, PlainTextObject placeholder, String initialValue, boolean multiline, Integer minLength, Integer maxLength)

Method Summary

Modifier and Type	Method and Description
static PlainTextInputElement.PlainTextInputElementBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getActionId() An identifier for the input value when the parent modal is submitted.
String	getInitialValue() The initial value in the plain-text input when it is loaded.
Integer	getMaxLength() The maximum length of input that the user can provide.
Integer	getMinLength() The minimum length of input that the user must provide.
PlainTextObject	getPlaceholder() A plain_text only text object that defines the placeholder text shown in the plain-text input.
String	getType()
int	hashCode()
boolean	isMultiline() Indicates whether the input will be a single line (false) or a larger textarea (true).
void	setActionId(String actionId) An identifier for the input value when the parent modal is submitted.
void	setInitialValue(String initialValue) The initial value in the plain-text input when it is loaded.
void	setMaxLength(Integer maxLength) The maximum length of input that the user can provide.
void	setMinLength(Integer minLength) The minimum length of input that the user must provide.
void	setMultiline(boolean multiline) Indicates whether the input will be a single line (false) or a larger textarea (true).
void	setPlaceholder(PlainTextObject placeholder) A plain_text only text object that defines the placeholder text shown in the plain-text input.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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)

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.

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.

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