class Slack::BlockKit::Element::ConversationsSelect

A select menu, just as with a standard HTML <select> tag, creates a drop down menu with a list of options for a user to choose. The select menu also includes type-ahead functionality, where a user can type a part or all of an option string to filter the list.

This select menu will populate its options with a list of public and private channels, DMs, and MPIMs visible to the current user in the active workspace.

api.slack.com/reference/messaging/block-elements#conversation-select

Constants

TYPE

Public Class Methods

new(placeholder:, action_id:, initial: nil, emoji: nil) { |self| ... } click to toggle source
# File lib/slack/block_kit/element/conversations_select.rb, line 21
def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
  @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
  @action_id = action_id
  @initial_conversation = initial
  @filter = nil

  yield(self) if block_given?
end

Public Instance Methods

as_json(*) click to toggle source
# File lib/slack/block_kit/element/conversations_select.rb, line 42
def as_json(*)
  {
    type: TYPE,
    placeholder: @placeholder.as_json,
    action_id: @action_id,
    initial_conversation: @initial_conversation,
    confirm: confirm&.as_json,
    filter: @filter&.as_json
  }.compact
end
filter(only: nil, exclude_external_shared_channels: nil, exclude_bot_users: nil) click to toggle source
# File lib/slack/block_kit/element/conversations_select.rb, line 30
def filter(only: nil,
           exclude_external_shared_channels: nil,
           exclude_bot_users: nil)
  @filter = Composition::ConversationFilter.new(
    only: only,
    exclude_external_shared_channels: exclude_external_shared_channels,
    exclude_bot_users: exclude_bot_users
  )

  self
end