Class: Discordrb::Webhooks::View::MediaGalleryBuilder

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

Overview

A media gallery component is a gallery grid.

Instance Method Summary collapse

Constructor Details

#initialize(id: nil) {|builder| ... } ⇒ MediaGalleryBuilder

Create a media gallery component.

Parameters:

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

    The unique 32-bit ID of the media gallery component.

Yield Parameters:



265
266
267
268
269
270
 
# File 'lib/discordrb/webhooks/view.rb', line 265

def initialize(id: nil)
  @id = id
  @items = []

  yield self if block_given?
end

Instance Method Details

#item(url:, description: nil, spoiler: false) ⇒ Object

Add a gallery item to the media gallery component.

Parameters:

  • url (String) —

    The URL to the gallery item's media.

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

    The description of the gallery item.

  • spoiler (true, false) (defaults to: false) —

    Whether or not to apply a spoiler label to the gallery item.



276
277
278
 
# File 'lib/discordrb/webhooks/view.rb', line 276

def item(url:, description: nil, spoiler: false)
  @items << { media: { url: }, description: description, spoiler: spoiler }.compact
end