Class: Discorb::SelectMenu::Option

Inherits:
Object
  • Object
show all
Defined in:
lib/discorb/components.rb

Overview

Represents an option of a select menu.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(label, value, description: nil, emoji: nil, default: false) -> Option

Initialize a new option.

Parameters:

  • label (String) —

    The label of the option.

  • value (String) —

    The value of the option.

  • description (String) (defaults to: nil) —

    The description of the option.

  • emoji (Discorb::Emoji) (defaults to: nil) —

    The emoji of the option.

  • default (Boolean) (defaults to: false) —

    Whether the option is default.



244
245
246
247
248
249
250
 
# File 'lib/discorb/components.rb', line 244

def initialize(label, value, description: nil, emoji: nil, default: false)
  @label = label
  @value = value
  @description = description
  @emoji = emoji
  @default = default
end

Instance Attribute Details

#default -> Boolean

Returns Whether the option is default.

Returns:

  • (Boolean) —

    Whether the option is default.



234
235
236
 
# File 'lib/discorb/components.rb', line 234

def default
  @default
end

#description -> String

Returns The description of the option.

Returns:

  • (String) —

    The description of the option.



230
231
232
 
# File 'lib/discorb/components.rb', line 230

def description
  @description
end

#emoji -> Discorb::Emoji

Returns The emoji of the option.

Returns:



232
233
234
 
# File 'lib/discorb/components.rb', line 232

def emoji
  @emoji
end

#label -> String

Returns The label of the option.

Returns:

  • (String) —

    The label of the option.



226
227
228
 
# File 'lib/discorb/components.rb', line 226

def label
  @label
end

#value -> String

Returns The value of the option.

Returns:

  • (String) —

    The value of the option.



228
229
230
 
# File 'lib/discorb/components.rb', line 228

def value
  @value
end

Class Method Details

.from_hash(data) -> Discorb::SelectMenu::Option

Creates a new option from a hash.

Parameters:

  • data (Hash) —

    A hash representing the option.

Returns:



294
295
296
 
# File 'lib/discorb/components.rb', line 294

def from_hash(data)
  new(data[:label], data[:value], description: data[:description], emoji: data[:emoji], default: data[:default])
end

Instance Method Details

#to_hash -> Hash

Converts the option to a hash.

Returns:

  • (Hash) —

    Hash representation of the option.

See Also:



258
259
260
261
262
263
264
265
266
 
# File 'lib/discorb/components.rb', line 258

def to_hash
  {
    label: @label,
    value: @value,
    description: @description,
    emoji: hash_emoji(@emoji),
    default: @default,
  }
end