Class: Rubycord::Webhooks::EmbedAuthor

Inherits:

Object

• Object
• Rubycord::Webhooks::EmbedAuthor

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

• #icon_url ⇒ String^?

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

• #name ⇒ String^?

  Name of the author.

• #url ⇒ String^?

  URL the name should link to.

Instance Method Summary

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

  Creates a new author object.

• #to_hash ⇒ Hash

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

Constructor Details

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

Creates a new author object.

# 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^?

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

def icon_url
  @icon_url
end

#name ⇒ String^?

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

def name
  @name
end

#url ⇒ String^?

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

def url
  @url
end

Instance Method Details

#to_hash ⇒ Hash

# File 'lib/rubycord/webhooks/embeds.rb', line 209

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