Class: Discordrb::Webhooks::View::RowBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/discordrb/webhooks/view.rb

Overview

This builder is used when constructing an ActionRow. All current components must be within an action row, but this can change in the future. A message can have 5 action rows, each action row can hold a weight of 5. Buttons have a weight of 1, and dropdowns have a weight of 5.

Instance Method Summary collapse

Instance Method Details

#button(style:, label: nil, emoji: nil, custom_id: nil, disabled: nil, url: nil) ⇒ Object

Add a button to this action row.

Parameters:

  • style (Symbol, Integer) —

    The button's style type. See BUTTON_STYLES

  • label (String, nil) (defaults to: nil) —

    The text label for the button. Either a label or emoji must be provided.

  • emoji (#to_h, String, Integer) (defaults to: nil) —

    An emoji ID, or unicode emoji to attach to the button. Can also be a object that responds to #to_h which returns a hash in the format of { id: Integer, name: string }.

  • custom_id (String) (defaults to: nil) —

    Custom IDs are used to pass state to the events that are raised from interactions. There is a limit of 100 characters to each custom_id.

  • disabled (true, false) (defaults to: nil) —

    Whether this button is disabled and shown as greyed out.

  • url (String, nil) (defaults to: nil) —

    The URL, when using a link style button.



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/discordrb/webhooks/view.rb', line 45

def button(style:, label: nil, emoji: nil, custom_id: nil, disabled: nil, url: nil)
  style = BUTTON_STYLES[style] || style

  emoji = case emoji
          when Integer, String
            emoji.to_i.positive? ? { id: emoji } : { name: emoji }
          else
            emoji.to_h
          end

  @components << { type: COMPONENT_TYPES[:button], label: label, emoji: emoji, style: style, custom_id: custom_id, disabled: disabled, url: url }
end

#channel_select(custom_id:, placeholder: nil, min_values: nil, max_values: nil, disabled: nil) ⇒ Object

Add a select channel to this action row.

Parameters:

  • custom_id (String) —

    Custom IDs are used to pass state to the events that are raised from interactions. There is a limit of 100 characters to each custom_id.

  • placeholder (String, nil) (defaults to: nil) —

    Default text to show when no entries are selected.

  • min_values (Integer, nil) (defaults to: nil) —

    The minimum amount of values a user must select.

  • max_values (Integer, nil) (defaults to: nil) —

    The maximum amount of values a user can select.

  • disabled (true, false, nil) (defaults to: nil) —

    Grey out the component to make it unusable.



117
118
119
 
# File 'lib/discordrb/webhooks/view.rb', line 117

def channel_select(custom_id:, placeholder: nil, min_values: nil, max_values: nil, disabled: nil)
  @components << SelectMenuBuilder.new(custom_id, [], placeholder, min_values, max_values, disabled, select_type: :channel_select).to_h
end

#mentionable_select(custom_id:, placeholder: nil, min_values: nil, max_values: nil, disabled: nil) ⇒ Object

Add a select mentionable to this action row.

Parameters:

  • custom_id (String) —

    Custom IDs are used to pass state to the events that are raised from interactions. There is a limit of 100 characters to each custom_id.

  • placeholder (String, nil) (defaults to: nil) —

    Default text to show when no entries are selected.

  • min_values (Integer, nil) (defaults to: nil) —

    The minimum amount of values a user must select.

  • max_values (Integer, nil) (defaults to: nil) —

    The maximum amount of values a user can select.

  • disabled (true, false, nil) (defaults to: nil) —

    Grey out the component to make it unusable.



106
107
108
 
# File 'lib/discordrb/webhooks/view.rb', line 106

def mentionable_select(custom_id:, placeholder: nil, min_values: nil, max_values: nil, disabled: nil)
  @components << SelectMenuBuilder.new(custom_id, [], placeholder, min_values, max_values, disabled, select_type: :mentionable_select).to_h
end

#role_select(custom_id:, placeholder: nil, min_values: nil, max_values: nil, disabled: nil) ⇒ Object

Add a select role to this action row.

Parameters:

  • custom_id (String) —

    Custom IDs are used to pass state to the events that are raised from interactions. There is a limit of 100 characters to each custom_id.

  • placeholder (String, nil) (defaults to: nil) —

    Default text to show when no entries are selected.

  • min_values (Integer, nil) (defaults to: nil) —

    The minimum amount of values a user must select.

  • max_values (Integer, nil) (defaults to: nil) —

    The maximum amount of values a user can select.

  • disabled (true, false, nil) (defaults to: nil) —

    Grey out the component to make it unusable.



95
96
97
 
# File 'lib/discordrb/webhooks/view.rb', line 95

def role_select(custom_id:, placeholder: nil, min_values: nil, max_values: nil, disabled: nil)
  @components << SelectMenuBuilder.new(custom_id, [], placeholder, min_values, max_values, disabled, select_type: :role_select).to_h
end

#string_select(custom_id:, options: [], placeholder: nil, min_values: nil, max_values: nil, disabled: nil) {|builder| ... } ⇒ Object Also known as: select_menu

Add a select string to this action row.

Parameters:

  • custom_id (String) —

    Custom IDs are used to pass state to the events that are raised from interactions. There is a limit of 100 characters to each custom_id.

  • options (Array<Hash>) (defaults to: []) —

    Options that can be selected in this menu. Can also be provided via the yielded builder.

  • placeholder (String, nil) (defaults to: nil) —

    Default text to show when no entries are selected.

  • min_values (Integer, nil) (defaults to: nil) —

    The minimum amount of values a user must select.

  • max_values (Integer, nil) (defaults to: nil) —

    The maximum amount of values a user can select.

  • disabled (true, false, nil) (defaults to: nil) —

    Grey out the component to make it unusable.

Yield Parameters:



67
68
69
70
71
72
73
 
# File 'lib/discordrb/webhooks/view.rb', line 67

def string_select(custom_id:, options: [], placeholder: nil, min_values: nil, max_values: nil, disabled: nil)
  builder = SelectMenuBuilder.new(custom_id, options, placeholder, min_values, max_values, disabled, select_type: :string_select)

  yield builder if block_given?

  @components << builder.to_h
end

#user_select(custom_id:, placeholder: nil, min_values: nil, max_values: nil, disabled: nil) ⇒ Object

Add a select user to this action row.

Parameters:

  • custom_id (String) —

    Custom IDs are used to pass state to the events that are raised from interactions. There is a limit of 100 characters to each custom_id.

  • placeholder (String, nil) (defaults to: nil) —

    Default text to show when no entries are selected.

  • min_values (Integer, nil) (defaults to: nil) —

    The minimum amount of values a user must select.

  • max_values (Integer, nil) (defaults to: nil) —

    The maximum amount of values a user can select.

  • disabled (true, false, nil) (defaults to: nil) —

    Grey out the component to make it unusable.



84
85
86
 
# File 'lib/discordrb/webhooks/view.rb', line 84

def user_select(custom_id:, placeholder: nil, min_values: nil, max_values: nil, disabled: nil)
  @components << SelectMenuBuilder.new(custom_id, [], placeholder, min_values, max_values, disabled, select_type: :user_select).to_h
end