Class: Discordrb::Webhooks::View

Inherits:

Object

• Object
• Discordrb::Webhooks::View

Defined in:

lib/discordrb/webhooks/view.rb

Overview

A reusable view representing a component collection, with builder methods.

Direct Known Subclasses

Components::View

Defined Under Namespace

Classes: RowBuilder, SelectMenuBuilder

Constant Summary

BUTTON_STYLES =

Possible button style names and values.

{
  primary: 1,
  secondary: 2,
  success: 3,
  danger: 4,
  link: 5
}.freeze

COMPONENT_TYPES =

Component types.

See Also:

• https://discord.com/developers/docs/interactions/message-components#component-types

{
  action_row: 1,
  button: 2,
  string_select: 3,
  # text_input: 4, # (defined in modal.rb)
  user_select: 5,
  role_select: 6,
  mentionable_select: 7,
  channel_select: 8
}.freeze

Instance Attribute Summary

• #rows ⇒ Object readonly

  Returns the value of attribute rows.

Instance Method Summary

• #initialize {|_self| ... } ⇒ View constructor

  A new instance of View.

• #row {|| ... } ⇒ Object

  Add a new ActionRow to the view.

Constructor Details

#initialize {|_self| ... } ⇒ View

Returns a new instance of View.

Yields:

• (_self)

Yield Parameters:

• _self (Discordrb::Webhooks::View) —

  the object that the method was called on

# File 'lib/discordrb/webhooks/view.rb', line 174

def initialize
  @rows = []

  yield self if block_given?
end

Instance Attribute Details

#rows ⇒ Object (readonly)

Returns the value of attribute rows.

# File 'lib/discordrb/webhooks/view.rb', line 172

def rows
  @rows
end

Instance Method Details

#row {|| ... } ⇒ Object

Add a new ActionRow to the view

Yield Parameters:

• (RowBuilder)

# File 'lib/discordrb/webhooks/view.rb', line 182

def row
  new_row = RowBuilder.new

  yield new_row

  @rows << new_row
end