Class: Slack::BlockKit::Element::UsersSelect

Inherits:
Object
  • Object
show all
Defined in:
lib/slack/block_kit/element/users_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 Slack users visible to the current user in the active workspace.

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

Constant Summary collapse

TYPE = 
'users_select'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(placeholder:, action_id:, initial: nil, emoji: nil) {|_self| ... } ⇒ UsersSelect

Returns a new instance of UsersSelect.

Yields:

  • (_self)

Yield Parameters:



20
21
22
23
24
25
26
 
# File 'lib/slack/block_kit/element/users_select.rb', line 20

def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
  @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
  @action_id = action_id
  @initial_user = initial

  yield(self) if block_given?
end

Instance Attribute Details

#confirm ⇒ Object

Returns the value of attribute confirm.



18
19
20
 
# File 'lib/slack/block_kit/element/users_select.rb', line 18

def confirm
  @confirm
end

Instance Method Details

#as_json ⇒ Object 



36
37
38
39
40
41
42
43
44
 
# File 'lib/slack/block_kit/element/users_select.rb', line 36

def as_json(*)
  {
    type: TYPE,
    placeholder: @placeholder.as_json,
    action_id: @action_id,
    initial_user: @initial_user,
    confirm: @confirm&.as_json
  }.compact
end

#confirmation_dialog {|@confirm| ... } ⇒ Object

Yields:



28
29
30
31
32
33
34
 
# File 'lib/slack/block_kit/element/users_select.rb', line 28

def confirmation_dialog
  @confirm = Composition::ConfirmationDialog.new

  yield(@confirm) if block_given?

  self
end