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

Class RichTextInputElement

java.lang.Object

com.slack.api.model.block.element.BlockElement

com.slack.api.model.block.element.RichTextInputElement

public class RichTextInputElement
extends BlockElement

https://api.slack.com/reference/block-kit/block-elements#rich_text_input

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RichTextInputElement.RichTextInputElementBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
RichTextInputElement()
RichTextInputElement(String actionId, RichTextBlock initialValue, DispatchActionConfig dispatchActionConfig, Boolean focusOnLoad, PlainTextObject placeholder)

Method Summary

Modifier and Type	Method	Description
static RichTextInputElement.RichTextInputElementBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getActionId()	An identifier for the input value when the parent modal is submitted.
DispatchActionConfig	getDispatchActionConfig()	A dispatch configuration object that determines when during text input the element returns a block_actions payload.
Boolean	getFocusOnLoad()	Indicates whether the element will be set to autofocus within the view object.
RichTextBlock	getInitialValue()	The initial value in the rich text input when it is loaded.
PlainTextObject	getPlaceholder()	A plain_text only text object that defines the placeholder text shown in the plain-text input.
String	getType()
int	hashCode()
void	setActionId(String actionId)	An identifier for the input value when the parent modal is submitted.
void	setDispatchActionConfig(DispatchActionConfig dispatchActionConfig)	A dispatch configuration object that determines when during text input the element returns a block_actions payload.
void	setFocusOnLoad(Boolean focusOnLoad)	Indicates whether the element will be set to autofocus within the view object.
void	setInitialValue(RichTextBlock initialValue)	The initial value in the rich text input when it is loaded.
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 Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

RichTextInputElement

public RichTextInputElement()

RichTextInputElement

public RichTextInputElement(String actionId,
 RichTextBlock initialValue,
 DispatchActionConfig dispatchActionConfig,
 Boolean focusOnLoad,
 PlainTextObject placeholder)

Method Details

builder

public static RichTextInputElement.RichTextInputElementBuilder 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.

getInitialValue

public RichTextBlock getInitialValue()

The initial value in the rich text input when it is loaded.

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 autofocus within the view object. Only one element can be set to true. Defaults to false.

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.

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.

setInitialValue

public void setInitialValue(RichTextBlock initialValue)

The initial value in the rich text input when it is loaded.

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 autofocus within the view object. Only one element can be set to true. Defaults to false.

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.

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