Class MultiConversationsSelectElement
- java.lang.Object
-
- com.slack.api.model.block.element.BlockElement
-
- com.slack.api.model.block.element.MultiConversationsSelectElement
-
public class MultiConversationsSelectElement extends BlockElement
https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMultiConversationsSelectElement.MultiConversationsSelectElementBuilder
-
Constructor Summary
Constructors Constructor Description MultiConversationsSelectElement()MultiConversationsSelectElement(PlainTextObject placeholder, String actionId, List<String> initialConversations, Boolean defaultToCurrentConversation, ConfirmationDialogObject confirm, Integer maxSelectedItems, ConversationsFilter filter, Boolean focusOnLoad)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MultiConversationsSelectElement.MultiConversationsSelectElementBuilderbuilder()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.BooleangetDefaultToCurrentConversation()Pre-populates the select menu with the conversation that the user was viewing when they opened the modal, if available.ConversationsFiltergetFilter()A filter object that reduces the list of available conversations using the specified criteria.BooleangetFocusOnLoad()Indicates whether the element will be set to auto focus within the view object.List<String>getInitialConversations()An array of one or more IDs of any valid conversations to be pre-selected when the menu loads.IntegergetMaxSelectedItems()Specifies the maximum number of items that can be selected in the menu.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.voidsetDefaultToCurrentConversation(Boolean defaultToCurrentConversation)Pre-populates the select menu with the conversation that the user was viewing when they opened the modal, if available.voidsetFilter(ConversationsFilter filter)A filter object that reduces the list of available conversations using the specified criteria.voidsetFocusOnLoad(Boolean focusOnLoad)Indicates whether the element will be set to auto focus within the view object.voidsetInitialConversations(List<String> initialConversations)An array of one or more IDs of any valid conversations to be pre-selected when the menu loads.voidsetMaxSelectedItems(Integer maxSelectedItems)Specifies the maximum number of items that can be selected in the menu.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
-
MultiConversationsSelectElement
public MultiConversationsSelectElement()
-
MultiConversationsSelectElement
public MultiConversationsSelectElement(PlainTextObject placeholder, String actionId, List<String> initialConversations, Boolean defaultToCurrentConversation, ConfirmationDialogObject confirm, Integer maxSelectedItems, ConversationsFilter filter, Boolean focusOnLoad)
-
-
Method Detail
-
builder
public static MultiConversationsSelectElement.MultiConversationsSelectElementBuilder 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.
-
getInitialConversations
public List<String> getInitialConversations()
An array of one or more IDs of any valid conversations to be pre-selected when the menu loads.
-
getDefaultToCurrentConversation
public Boolean getDefaultToCurrentConversation()
Pre-populates the select menu with the conversation that the user was viewing when they opened the modal, if available. If initial_conversation is also supplied, it will be ignored. Default is false.
-
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.
-
getFilter
public ConversationsFilter getFilter()
A filter object that reduces the list of available conversations using the specified criteria.
-
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.
-
setInitialConversations
public void setInitialConversations(List<String> initialConversations)
An array of one or more IDs of any valid conversations to be pre-selected when the menu loads.
-
setDefaultToCurrentConversation
public void setDefaultToCurrentConversation(Boolean defaultToCurrentConversation)
Pre-populates the select menu with the conversation that the user was viewing when they opened the modal, if available. If initial_conversation is also supplied, it will be ignored. Default is false.
-
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.
-
setFilter
public void setFilter(ConversationsFilter filter)
A filter object that reduces the list of available conversations using the specified criteria.
-
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)
-
-