View Source Nostrum.Struct.Component.Option (Nostrum v0.8.0)

Component Options

Link to this section Summary

Types

If this option is selected by default.

An optional description of the option. Max length is 100 characters.

The user-facing name of the option.

t()

The developer defined value of the option.

Link to this section Types

Link to this type

default()

View Source (since 0.5.0)
@type default() :: boolean() | nil

If this option is selected by default.

Link to this type

description()

View Source (since 0.5.0)
@type description() :: String.t() | nil

An optional description of the option. Max length is 100 characters.

@type emoji() :: Nostrum.Struct.Component.emoji()
@type label() :: Nostrum.Struct.Component.label()

The user-facing name of the option.

@type t() :: %Nostrum.Struct.Component.Option{
  default: default(),
  description: description(),
  emoji: emoji(),
  label: label(),
  value: value()
}
@type value() :: String.t()

The developer defined value of the option.