Class MultiExternalSelectElement
- java.lang.Object
-
- com.slack.api.model.block.element.BlockElement
-
- com.slack.api.model.block.element.MultiExternalSelectElement
-
public class MultiExternalSelectElement extends BlockElement
https://api.slack.com/reference/block-kit/block-elements#external_multi_select
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMultiExternalSelectElement.MultiExternalSelectElementBuilder
-
Constructor Summary
Constructors Constructor Description MultiExternalSelectElement()MultiExternalSelectElement(PlainTextObject placeholder, String actionId, List<OptionObject> initialOptions, Integer minQueryLength, ConfirmationDialogObject confirm, Integer maxSelectedItems, Boolean focusOnLoad)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MultiExternalSelectElement.MultiExternalSelectElementBuilderbuilder()protected booleancanEqual(Object other)booleanequals(Object o)StringgetActionId()An identifier for the action triggered when a menu option is selected.ConfirmationDialogObjectgetConfirm()A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.BooleangetFocusOnLoad()Indicates whether the element will be set to auto focus within the view object.List<OptionObject>getInitialOptions()An array of option objects that exactly match one or more of the options within options or option_groups.IntegergetMaxSelectedItems()Specifies the maximum number of items that can be selected in the menu.IntegergetMinQueryLength()When the typeahead field is used, a request will be sent on every character change.PlainTextObjectgetPlaceholder()A plain_text only text object that defines the placeholder text shown on the menu.StringgetType()inthashCode()voidsetActionId(String actionId)An identifier for the action triggered when a menu option is selected.voidsetConfirm(ConfirmationDialogObject confirm)A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.voidsetFocusOnLoad(Boolean focusOnLoad)Indicates whether the element will be set to auto focus within the view object.voidsetInitialOptions(List<OptionObject> initialOptions)An array of option objects that exactly match one or more of the options within options or option_groups.voidsetMaxSelectedItems(Integer maxSelectedItems)Specifies the maximum number of items that can be selected in the menu.voidsetMinQueryLength(Integer minQueryLength)When the typeahead field is used, a request will be sent on every character change.voidsetPlaceholder(PlainTextObject placeholder)A plain_text only text object that defines the placeholder text shown on the menu.StringtoString()
-
-
-
Field Detail
-
TYPE
public static final String TYPE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MultiExternalSelectElement
public MultiExternalSelectElement()
-
MultiExternalSelectElement
public MultiExternalSelectElement(PlainTextObject placeholder, String actionId, List<OptionObject> initialOptions, Integer minQueryLength, ConfirmationDialogObject confirm, Integer maxSelectedItems, Boolean focusOnLoad)
-
-
Method Detail
-
builder
public static MultiExternalSelectElement.MultiExternalSelectElementBuilder 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.
-
getInitialOptions
public List<OptionObject> getInitialOptions()
An array of option objects that exactly match one or more of the options within options or option_groups. These options 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 before the multi-select choices are submitted.
-
getMaxSelectedItems
public Integer getMaxSelectedItems()
Specifies the maximum number of items that can be selected in the menu. Minimum number is 1.
-
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.
-
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.
-
setInitialOptions
public void setInitialOptions(List<OptionObject> initialOptions)
An array of option objects that exactly match one or more of the options within options or option_groups. These options 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 before the multi-select choices are submitted.
-
setMaxSelectedItems
public void setMaxSelectedItems(Integer maxSelectedItems)
Specifies the maximum number of items that can be selected in the menu. Minimum number is 1.
-
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)
-
-