Method: Viberroo::Message.rich

Defined in:
lib/viberroo/message.rb

.rich(params) ⇒ Hash

The Rich Media message type allows sending messages with pre-defined layout, including height (rows number), width (columns number), text, images and buttons.

Examples:

Send a rich media

search = Button.reply({
  Columns: 4,
  Rows: 3,
  ActionBody: '/search',
  Text: 'Search something...'
}

locate = Button.reply({
  Columns: 4,
  Rows: 3,
  ActionBody: '/near_me'
}

browse = Button.url({
  Columns: 4,
  Rows: 2,
  ActionBody: 'parrot.live',
  Text: 'Browse something wierd'
}

@bot.send_rich_media(
  rich_media: {
    ButtonsGroupColumns: 4,
    ButtonsGroupRows: 6,
    Buttons: [search, locate, browse]
  }
)

Parameters:

  • params (Hash)

Options Hash (params):

  • rich_media (Hash)
  • rich_media.ButtonsGroupColumns (Integer) —

    Number of columns per carousel content block. Possible values 1 - 6. **API Default**: 6.

  • rich_media.ButtonsGroupRows (Integer) —

    Number of rows per carousel content block. Possible values 1 - 7. **API Default**: 7.

  • rich_media.Buttons (Hash) —

    Array of buttons. Max of 6 * ButtonsGroupColumns * ButtonsGroupRows.

Returns:

  • (Hash)

See Also:



69
70
71
 
# File 'lib/viberroo/message.rb', line 69

def self.rich(params)
  { type: :rich_media, min_api_version: 2 }.merge(params)
end