Class: Slack::BlockKit::Element::ConversationsSelect

Inherits:
Object
  • Object
show all
Includes:
Composition::ConfirmationDialog::Confirmable
Defined in:
lib/slack/block_kit/element/conversations_select.rb

Overview

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

Constant Summary collapse

TYPE = 
'conversations_select'

Instance Method Summary collapse

Methods included from Composition::ConfirmationDialog::Confirmable

#confirmation_dialog, included

Constructor Details

#initialize(placeholder:, action_id:, initial: nil, emoji: nil, focus_on_load: nil, default_to_current_conversation: nil, response_url_enabled: nil) {|_self| ... } ⇒ ConversationsSelect

Returns a new instance of ConversationsSelect.

Yields:

  • (_self)

Yield Parameters:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/slack/block_kit/element/conversations_select.rb', line 21

def initialize(
  placeholder:,
  action_id:,
  initial: nil,
  emoji: nil,
  focus_on_load: nil,
  default_to_current_conversation: nil,
  response_url_enabled: nil
)
  @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
  @action_id = action_id
  @initial_conversation = initial
  @focus_on_load = focus_on_load
  @filter = nil
  @default_to_current_conversation = default_to_current_conversation
  @response_url_enabled = response_url_enabled

  yield(self) if block_given?
end

Instance Method Details

#as_json ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/slack/block_kit/element/conversations_select.rb', line 53

def as_json(*)
  {
    type: TYPE,
    placeholder: @placeholder.as_json,
    action_id: @action_id,
    focus_on_load: @focus_on_load,
    initial_conversation: @initial_conversation,
    confirm: confirm&.as_json,
    filter: @filter&.as_json,
    default_to_current_conversation: @default_to_current_conversation,
    response_url_enabled: @response_url_enabled
  }.compact
end

#filter(only: nil, exclude_external_shared_channels: nil, exclude_bot_users: nil) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/slack/block_kit/element/conversations_select.rb', line 41

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