Class ConversationsSelectElement
java.lang.Object
com.slack.api.model.block.element.BlockElement
com.slack.api.model.block.element.ConversationsSelectElement
https://api.slack.com/reference/block-kit/block-elements#conversation_select
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
-
Field Summary
-
Constructor Summary
ConstructorDescriptionConversationsSelectElement
(PlainTextObject placeholder, String actionId, String initialConversation, Boolean defaultToCurrentConversation, ConfirmationDialogObject confirm, Boolean responseUrlEnabled, ConversationsFilter filter, Boolean focusOnLoad) -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
protected boolean
boolean
An identifier for the action triggered when a menu option is selected.A confirm object that defines an optional confirmation dialog that appears after a menu item is selected.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 auto focus within the view object.The ID of any valid conversation to be pre-selected when the menu loads.A plain_text only text object that defines the placeholder text shown on the menu.This field only works with menus in input blocks in modals.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
setDefaultToCurrentConversation
(Boolean defaultToCurrentConversation) Pre-populates the select menu with the conversation that the user was viewing when they opened the modal, if available.void
setFilter
(ConversationsFilter filter) A filter object that reduces the list of available conversations using the specified criteria.void
setFocusOnLoad
(Boolean focusOnLoad) Indicates whether the element will be set to auto focus within the view object.void
setInitialConversation
(String initialConversation) The ID of any valid conversation to be pre-selected when the menu loads.void
setPlaceholder
(PlainTextObject placeholder) A plain_text only text object that defines the placeholder text shown on the menu.void
setResponseUrlEnabled
(Boolean responseUrlEnabled) This field only works with menus in input blocks in modals.toString()
-
Field Details
-
TYPE
- See Also:
-
-
Constructor Details
-
ConversationsSelectElement
public ConversationsSelectElement() -
ConversationsSelectElement
public ConversationsSelectElement(PlainTextObject placeholder, String actionId, String initialConversation, Boolean defaultToCurrentConversation, ConfirmationDialogObject confirm, Boolean responseUrlEnabled, ConversationsFilter filter, Boolean focusOnLoad)
-
-
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. -
getInitialConversation
The ID of any valid conversation 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 after a menu item is selected. -
getResponseUrlEnabled
This field only works with menus in input blocks in modals. When set to true, the view_submission payload from the menu's parent view will contain a response_url. This response_url can be used for message responses. The target conversation for the message will be determined by the value of this select menu. -
getFilter
A filter object that reduces the list of available conversations using the specified criteria. -
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
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. -
setInitialConversation
The ID of any valid conversation 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 after a menu item is selected. -
setResponseUrlEnabled
This field only works with menus in input blocks in modals. When set to true, the view_submission payload from the menu's parent view will contain a response_url. This response_url can be used for message responses. The target conversation for the message will be determined by the value of this select menu. -
setFilter
A filter object that reduces the list of available conversations using the specified criteria. -
setFocusOnLoad
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. -
toString
-
equals
-
canEqual
-
hashCode
public int hashCode()
-