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

Component Options

Summary

Types

default()

If this option is selected by default.

description()

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

emoji()

label()

The user-facing name of the option.

t()

value()

The developer defined value of the option.

Types

default()

(since 0.5.0)

@type default() :: boolean() | nil

If this option is selected by default.

description()

(since 0.5.0)

@type description() :: String.t() | nil

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

emoji()

(since 0.5.0)

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

label()

(since 0.5.0)

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

The user-facing name of the option.

t()

(since 0.5.0)

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

value()

(since 0.5.0)

@type value() :: String.t()

The developer defined value of the option.