Class: Rubycord::Webhooks::EmbedAuthor

Inherits:
Object
  • Object
show all
Defined in:
lib/rubycord/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.



202
203
204
205
206
 
# File 'lib/rubycord/webhooks/embeds.rb', line 202

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



196
197
198
 
# File 'lib/rubycord/webhooks/embeds.rb', line 196

def icon_url
  @icon_url
end

#name ⇒ String?

Returns name of the author.

Returns:

  • (String, nil) —

    name of the author



190
191
192
 
# File 'lib/rubycord/webhooks/embeds.rb', line 190

def name
  @name
end

#url ⇒ String?

Returns URL the name should link to.

Returns:

  • (String, nil) —

    URL the name should link to



193
194
195
 
# File 'lib/rubycord/webhooks/embeds.rb', line 193

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.



209
210
211
212
213
214
215
 
# File 'lib/rubycord/webhooks/embeds.rb', line 209

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