Class: Discorb::Embed::Author

Inherits:
Entry
  • Object
show all
Defined in:
lib/discorb/embed.rb

Overview

Represents an author of embed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, url: nil, icon: nil) -> Author

Initialize a new Author object.

Parameters:

  • name (String) —

    The name of author.

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

    The url of author.

  • icon (String) (defaults to: nil) —

    The icon url of author.



183
184
185
186
187
 
# File 'lib/discorb/embed.rb', line 183

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

Instance Attribute Details

#icon -> String?

Returns The icon url of author.

Returns:

  • (String, nil) —

    The icon url of author.



174
175
176
 
# File 'lib/discorb/embed.rb', line 174

def icon
  @icon
end

#name -> String

Returns The name of author.

Returns:

  • (String) —

    The name of author.



170
171
172
 
# File 'lib/discorb/embed.rb', line 170

def name
  @name
end

#url -> String?

Returns The url of author.

Returns:

  • (String, nil) —

    The url of author.



172
173
174
 
# File 'lib/discorb/embed.rb', line 172

def url
  @url
end

Instance Method Details

#to_hash -> Hash

Convert author to hash.

Returns:

  • (Hash) —

    Converted author.

See Also:



196
197
198
 
# File 'lib/discorb/embed.rb', line 196

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