Class: Discorb::Embed::Footer

Inherits:

Entry

• Object
• Entry
• Discorb::Embed::Footer

Defined in:

lib/discorb/embed.rb

Overview

Represemts a footer of embed.

Instance Attribute Summary

• #icon -> Object

  Returns the value of attribute icon.

• #text -> Object

  Returns the value of attribute text.

Instance Method Summary

• #initialize(text, icon: nil) -> Footer constructor

  Initialize a new Footer object.

• #to_hash -> Hash

  Convert footer to hash.

Constructor Details

#initialize(text, icon: nil) -> Footer

Initialize a new Footer object.

Parameters:

• text (String) —

  The text of footer.

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

  The icon url of footer.

# File 'lib/discorb/embed.rb', line 213

def initialize(text, icon: nil)
  @text = text
  @icon = icon
end

Instance Attribute Details

#icon -> Object

Returns the value of attribute icon.

# File 'lib/discorb/embed.rb', line 205

def icon
  @icon
end

#text -> Object

Returns the value of attribute text.

# File 'lib/discorb/embed.rb', line 205

def text
  @text
end

Instance Method Details

#to_hash -> Hash

Convert footer to hash.

Returns:

• (Hash) —

  Converted footer.

See Also:

• Offical Discord API Docs

# File 'lib/discorb/embed.rb', line 225

def to_hash
  { text: @text, icon_url: @icon }
end