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

Class ConversationsSelectElement

java.lang.Object
com.slack.api.model.block.element.BlockElement
com.slack.api.model.block.element.ConversationsSelectElement
public class ConversationsSelectElement extends BlockElement
https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#conversation_multi_select

  • Field Details

  • Constructor Details

    • ConversationsSelectElement

      public ConversationsSelectElement()

    • ConversationsSelectElement

      public ConversationsSelectElement(PlainTextObject placeholder, String actionId, String initialConversation, Boolean defaultToCurrentConversation, ConfirmationDialogObject confirm, Boolean responseUrlEnabled, ConversationsFilter filter, Boolean focusOnLoad)
      Creates a new ConversationsSelectElement instance.
      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.
      initialConversation - The ID of any valid conversation 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 after a menu item is selected.
      responseUrlEnabled - 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.
      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

      public static ConversationsSelectElement.ConversationsSelectElementBuilder 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.

    • getInitialConversation

      public String getInitialConversation()
      The ID of any valid conversation 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 after a menu item is selected.

    • getResponseUrlEnabled

      public Boolean 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

      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 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.

    • setInitialConversation

      public void setInitialConversation(String initialConversation)
      The ID of any valid conversation 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 after a menu item is selected.

    • setResponseUrlEnabled

      public void setResponseUrlEnabled(Boolean responseUrlEnabled)
      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

      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 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