Class MultiConversationsSelectElement
java.lang.Object
com.slack.api.model.block.element.BlockElement
com.slack.api.model.block.element.MultiConversationsSelectElement
https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#conversation_multi_select
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionMultiConversationsSelectElement(PlainTextObject placeholder, String actionId, List<String> initialConversations, Boolean defaultToCurrentConversation, ConfirmationDialogObject confirm, Integer maxSelectedItems, ConversationsFilter filter, Boolean focusOnLoad) Creates a newMultiConversationsSelectElementinstance. -
Method Summary
Modifier and TypeMethodDescriptionbuilder()protected booleanbooleanAn identifier for the action triggered when a menu option is selected.A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.Pre-populates the select menu with the conversation that the user was viewing when they opened the modal, if available.A filter object that reduces the list of available conversations using the specified criteria.Indicates whether the element will be set to autofocus within the view object.An array of one or more IDs of any valid conversations to be pre-selected when the menu loads.Specifies the maximum number of items that can be selected in the menu.A plain_text only text object that defines the placeholder text shown on the menu.getType()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 autofocus 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.toString()
-
Field Details
-
TYPE
- See Also:
-
-
Constructor Details
-
MultiConversationsSelectElement
public MultiConversationsSelectElement() -
MultiConversationsSelectElement
public MultiConversationsSelectElement(PlainTextObject placeholder, String actionId, List<String> initialConversations, Boolean defaultToCurrentConversation, ConfirmationDialogObject confirm, Integer maxSelectedItems, ConversationsFilter filter, Boolean focusOnLoad) Creates a newMultiConversationsSelectElementinstance.- Parameters:
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.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.initialConversations- An array of one or more IDs of any valid conversations to be pre-selected when the menu loads.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.confirm- A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.maxSelectedItems- Specifies the maximum number of items that can be selected in the menu. Minimum number is 1.filter- A filter object that reduces the list of available conversations using the specified criteria.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.
-
-
Method Details
-
builder
-
getType
-
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
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
An array of one or more IDs of any valid conversations to be pre-selected when the menu loads. -
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
A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted. -
getMaxSelectedItems
Specifies the maximum number of items that can be selected in the menu. Minimum number is 1. -
getFilter
A filter object that reduces the list of available conversations using the specified criteria. -
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
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
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
An array of one or more IDs of any valid conversations to be pre-selected when the menu loads. -
setDefaultToCurrentConversation
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
A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted. -
setMaxSelectedItems
Specifies the maximum number of items that can be selected in the menu. Minimum number is 1. -
setFilter
A filter object that reduces the list of available conversations using the specified criteria. -
setFocusOnLoad
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
-
equals
-
canEqual
-
hashCode
public int hashCode()
-