Class: Discorb::Embed::Field

Inherits:

Entry

• Object
• Entry
• Discorb::Embed::Field

Defined in:

lib/discorb/embed.rb

Overview

Represents a field of embed.

Instance Attribute Summary

• #inline ⇒ Boolean

  Whether the field is inline.

• #name ⇒ String

  The name of field.

• #value ⇒ String

  The value of field.

Instance Method Summary

• #initialize(name, value, inline: true) ⇒ Field constructor

  Initialize a new Field object.

• #to_hash ⇒ Hash

  Convert field to hash.

Constructor Details

#initialize(name, value, inline: true) ⇒ Field

Initialize a new Field object.

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

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

Instance Attribute Details

#inline ⇒ Boolean

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

def inline
  @inline
end

#name ⇒ String

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

def name
  @name
end

#value ⇒ String

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

def value
  @value
end

Instance Method Details

#to_hash ⇒ Hash

Convert field to hash.

See Also:

• Offical Discord API Docs

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

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