Class: Discordrb::Webhooks::EmbedField

Inherits:

Object

• Object
• Discordrb::Webhooks::EmbedField

Defined in:

lib/discordrb/webhooks/embeds.rb

Overview

A field is a small block of text with a header that can be relatively freely layouted with other fields.

Instance Attribute Summary

• #inline ⇒ true, false

  Whether the field should be displayed inline with other fields.

• #name ⇒ String^?

  Name of the field, displayed in bold at the top of the field.

• #value ⇒ String^?

  Value of the field, displayed in normal text below the name.

Instance Method Summary

• #initialize(name: nil, value: nil, inline: false) ⇒ EmbedField constructor

  Creates a new field object.

• #to_hash ⇒ Hash

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

Constructor Details

#initialize(name: nil, value: nil, inline: false) ⇒ EmbedField

Creates a new field object.

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

def initialize(name: nil, value: nil, inline: false)
  @name = name
  @value = value
  @inline = inline
end

Instance Attribute Details

#inline ⇒ true, false

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

def inline
  @inline
end

#name ⇒ String^?

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

def name
  @name
end

#value ⇒ String^?

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

def value
  @value
end

Instance Method Details

#to_hash ⇒ Hash

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

def to_hash
  {
    name: @name,
    value: @value,
    inline: @inline
  }
end