Class: OnyxCord::Components::Label

Inherits:

Object

• Object
• OnyxCord::Components::Label

Defined in:

lib/onyxcord/models/component.rb

Overview

A parent component for interactive modal components.

Instance Attribute Summary

• #component ⇒ Component readonly

  The interactive component of the label.

• #description ⇒ String^? readonly

  The optional description text for the label.

• #id ⇒ Integer readonly

  The numeric identifier of the label.

• #label ⇒ String readonly

  The visible label text for the modal component.

Instance Attribute Details

#component ⇒ Component (readonly)

Returns the interactive component of the label.

Returns:

• (Component) —

  the interactive component of the label.

# File 'lib/onyxcord/models/component.rb', line 498

def component
  @component
end

#description ⇒ String^? (readonly)

Returns the optional description text for the label.

Returns:

• (String, nil) —

  the optional description text for the label.

# File 'lib/onyxcord/models/component.rb', line 495

def description
  @description
end

#id ⇒ Integer (readonly)

Returns the numeric identifier of the label.

Returns:

• (Integer) —

  the numeric identifier of the label.

# File 'lib/onyxcord/models/component.rb', line 489

def id
  @id
end

#label ⇒ String (readonly)

Returns the visible label text for the modal component.

Returns:

• (String) —

  the visible label text for the modal component.

# File 'lib/onyxcord/models/component.rb', line 492

def label
  @label
end