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

Class ExternalSelectElement

java.lang.Object

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

com.slack.api.model.block.element.ExternalSelectElement

public class ExternalSelectElement
extends BlockElement

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExternalSelectElement.ExternalSelectElementBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
ExternalSelectElement()
ExternalSelectElement(PlainTextObject placeholder, String actionId, OptionObject initialOption, Integer minQueryLength, ConfirmationDialogObject confirm, Boolean focusOnLoad)

Method Summary

Modifier and Type	Method	Description
static ExternalSelectElement.ExternalSelectElementBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getActionId()	An identifier for the action triggered when a menu option is selected.
ConfirmationDialogObject	getConfirm()	A confirm object that defines an optional confirmation dialog that appears after a menu item is selected.
Boolean	getFocusOnLoad()	Indicates whether the element will be set to autofocus within the view object.
OptionObject	getInitialOption()	A single option that exactly matches one of the options within the options or option_groups loaded from the external data source.
Integer	getMinQueryLength()	When the typeahead field is used, a request will be sent on every character change.
PlainTextObject	getPlaceholder()	A plain_text only text object that defines the placeholder text shown on the menu.
String	getType()
int	hashCode()
void	setActionId(String actionId)	An identifier for the action triggered when a menu option is selected.
void	setConfirm(ConfirmationDialogObject confirm)	A confirm object that defines an optional confirmation dialog that appears after a menu item is selected.
void	setFocusOnLoad(Boolean focusOnLoad)	Indicates whether the element will be set to autofocus within the view object.
void	setInitialOption(OptionObject initialOption)	A single option that exactly matches one of the options within the options or option_groups loaded from the external data source.
void	setMinQueryLength(Integer minQueryLength)	When the typeahead field is used, a request will be sent on every character change.
void	setPlaceholder(PlainTextObject placeholder)	A plain_text only text object that defines the placeholder text shown on the menu.
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

ExternalSelectElement

public ExternalSelectElement()

ExternalSelectElement

public ExternalSelectElement(PlainTextObject placeholder,
 String actionId,
 OptionObject initialOption,
 Integer minQueryLength,
 ConfirmationDialogObject confirm,
 Boolean focusOnLoad)

Method Details

builder

public static ExternalSelectElement.ExternalSelectElementBuilder builder()

getType

public String getType()

getPlaceholder

public PlainTextObject getPlaceholder()

A plain_text only text object that defines the placeholder text shown on the menu. Maximum length for the text in this field is 150 characters.

getActionId

public String getActionId()

An identifier for the action triggered when a menu option is selected. You can use this when you receive an interaction payload to identify the source of the action. Should be unique among all other action_ids used elsewhere by your app. Maximum length for this field is 255 characters.

getInitialOption

public OptionObject getInitialOption()

A single option that exactly matches one of the options within the options or option_groups loaded from the external data source. This option will be selected when the menu initially loads.

getMinQueryLength

public Integer getMinQueryLength()

When the typeahead field is used, a request will be sent on every character change. If you prefer fewer requests or more fully ideated queries, use the min_query_length attribute to tell Slack the fewest number of typed characters required before dispatch.

getConfirm

public ConfirmationDialogObject getConfirm()

A confirm object that defines an optional confirmation dialog that appears after a menu item is selected.

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.

setPlaceholder

public void setPlaceholder(PlainTextObject placeholder)

A plain_text only text object that defines the placeholder text shown on the menu. Maximum length for the text in this field is 150 characters.

setActionId

public void setActionId(String actionId)

An identifier for the action triggered when a menu option is selected. You can use this when you receive an interaction payload to identify the source of the action. Should be unique among all other action_ids used elsewhere by your app. Maximum length for this field is 255 characters.

setInitialOption

public void setInitialOption(OptionObject initialOption)

A single option that exactly matches one of the options within the options or option_groups loaded from the external data source. This option will be selected when the menu initially loads.

setMinQueryLength

public void setMinQueryLength(Integer minQueryLength)

When the typeahead field is used, a request will be sent on every character change. If you prefer fewer requests or more fully ideated queries, use the min_query_length attribute to tell Slack the fewest number of typed characters required before dispatch.

setConfirm

public void setConfirm(ConfirmationDialogObject confirm)

A confirm object that defines an optional confirmation dialog that appears after a menu item is selected.

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.

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