Class: Discordrb::Webhooks::EmbedFooter

Inherits:

Object

Object
Discordrb::Webhooks::EmbedFooter

show all

Defined in:: lib/discordrb/webhooks/embeds.rb

Overview

An embed's footer will be displayed at the very bottom of an embed, together with the timestamp. An icon URL can be set together with some text to be displayed.

Instance Attribute Summary collapse

#icon_url ⇒ String^?
URL to an icon to be showed alongside the text.
#text ⇒ String^?
Text to be displayed in the footer.

Instance Method Summary collapse

#initialize(text: nil, icon_url: nil) ⇒ EmbedFooter constructor
Creates a new footer object.
#to_hash ⇒ Hash
A hash representation of this embed footer, to be converted to JSON.

Constructor Details

#initialize(text: nil, icon_url: nil) ⇒ `EmbedFooter`

Creates a new footer object.

# File 'lib/discordrb/webhooks/embeds.rb', line 136

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

Instance Attribute Details

#icon_url ⇒ `String`^?



131
132
133

# File 'lib/discordrb/webhooks/embeds.rb', line 131

def icon_url
  @icon_url
end

#text ⇒ `String`^?



128
129
130

# File 'lib/discordrb/webhooks/embeds.rb', line 128

def text
  @text
end

Instance Method Details

#to_hash ⇒ `Hash`

# File 'lib/discordrb/webhooks/embeds.rb', line 142

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