Class: Discordrb::Webhooks::EmbedAuthor

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

Overview

An embed's author will be shown at the top to indicate who "authored" the particular event the webhook was sent for.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: nil, url: nil, icon_url: nil) ⇒ EmbedAuthor

Creates a new author object.

Parameters:

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

    The name of the author.

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

    The URL the name should link to.

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

    The URL of the icon to be displayed next to the author.



204
205
206
207
208
 
# File 'lib/discordrb/webhooks/embeds.rb', line 204

def initialize(name: nil, url: nil, icon_url: nil)
  @name = name
  @url = url
  @icon_url = icon_url
end

Instance Attribute Details

#icon_url ⇒ String?

Returns URL of the icon to be displayed next to the author.

Returns:

  • (String, nil) —

    URL of the icon to be displayed next to the author



198
199
200
 
# File 'lib/discordrb/webhooks/embeds.rb', line 198

def icon_url
  @icon_url
end

#name ⇒ String?

Returns name of the author.

Returns:

  • (String, nil) —

    name of the author



192
193
194
 
# File 'lib/discordrb/webhooks/embeds.rb', line 192

def name
  @name
end

#url ⇒ String?

Returns URL the name should link to.

Returns:

  • (String, nil) —

    URL the name should link to



195
196
197
 
# File 'lib/discordrb/webhooks/embeds.rb', line 195

def url
  @url
end

Instance Method Details

#to_hash ⇒ Hash

Returns a hash representation of this embed author, to be converted to JSON.

Returns:

  • (Hash) —

    a hash representation of this embed author, to be converted to JSON.



211
212
213
214
215
216
217
 
# File 'lib/discordrb/webhooks/embeds.rb', line 211

def to_hash
  {
    name: @name,
    url: @url,
    icon_url: @icon_url
  }
end