Class: Ruqqus::Title

Inherits:

Object

• Object
• Ruqqus::Title

Defined in:

lib/ruqqus/types/title.rb

Overview

Describes a title associated with a username.

Instance Attribute Summary

• #color ⇒ String readonly

  The color used to display the title in HTML format.

• #id ⇒ Integer readonly

  A unique ID associated with this title.

• #kind ⇒ Integer readonly

  An integer determining the "rank" of the title.

• #text ⇒ String readonly

  The text value of the title.

Instance Method Summary

• #initialize(data) ⇒ Title constructor

  Creates a new instance of the Title class.

Constructor Details

#initialize(data) ⇒ Title

Creates a new instance of the Ruqqus::Title class.

Parameters:

• data (Hash) —

  the parsed JSON payload defining this instance.

# File 'lib/ruqqus/types/title.rb', line 28

def initialize(data)
  @data = data || raise(ArgumentError, 'data cannot be nil')
end

Instance Attribute Details

#color ⇒ String (readonly)

Returns the color used to display the title in HTML format.

Returns:

• (String) —

  the color used to display the title in HTML format.

# File 'lib/ruqqus/types/title.rb', line 16

#id ⇒ Integer (readonly)

Returns a unique ID associated with this title.

Returns:

• (Integer) —

  a unique ID associated with this title.

# File 'lib/ruqqus/types/title.rb', line 8

#kind ⇒ Integer (readonly)

Returns an integer determining the "rank" of the title.

Returns:

• (Integer) —

  an integer determining the "rank" of the title.

# File 'lib/ruqqus/types/title.rb', line 20

#text ⇒ String (readonly)

Returns the text value of the title.

Returns:

• (String) —

  the text value of the title.

# File 'lib/ruqqus/types/title.rb', line 12