Class: Discordrb::Components::Checkbox

Inherits:

Object

• Object
• Discordrb::Components::Checkbox

Defined in:

lib/discordrb/data/component.rb

Overview

A checkbox that can be ticked in a modal.

Instance Attribute Summary

• #custom_id ⇒ String readonly

  The developer-defined identifier for the checkbox.

• #id ⇒ Integer readonly

  The numeric identifier of the checkbox.

• #value ⇒ true, false (also: #value?) readonly

  Whether or not the checkbox was selected.

Instance Attribute Details

#custom_id ⇒ String (readonly)

Returns the developer-defined identifier for the checkbox.

Returns:

• (String) —

  the developer-defined identifier for the checkbox.

# File 'lib/discordrb/data/component.rb', line 567

def custom_id
  @custom_id
end

#id ⇒ Integer (readonly)

Returns the numeric identifier of the checkbox.

Returns:

• (Integer) —

  the numeric identifier of the checkbox.

# File 'lib/discordrb/data/component.rb', line 560

def id
  @id
end

#value ⇒ true, false (readonly) Also known as: value?

Returns whether or not the checkbox was selected.

Returns:

• (true, false) —

  whether or not the checkbox was selected.

# File 'lib/discordrb/data/component.rb', line 563

def value
  @value
end