dpp::select_option Struct Reference

An option for a select component. More...

#include <message.h>

Inheritance diagram for dpp::select_option:

Collaboration diagram for dpp::select_option:

Classes
struct	inner_select_emoji
	Emoji definition. To set an emoji on your button you must set one of either the name or id fields. The easiest way is to use the component::set_emoji method. More...

Public Member Functions
	select_option ()
	Construct a new select option object. More...
virtual	~select_option ()=default
	Destructs the select option object. More...
	select_option (const std::string &label, const std::string &value, const std::string &description="")
	Construct a new select option object. More...
select_option &	set_label (const std::string &l)
	Set the label. More...
select_option &	set_value (const std::string &v)
	Set the value. More...
select_option &	set_description (const std::string &d)
	Set the description. More...
select_option &	set_emoji (const std::string &n, dpp::snowflake id=0, bool animated=false)
	Set the emoji. More...
select_option &	set_default (bool def)
	Set the option as default. More...
select_option &	set_animated (bool anim)
	Set the emoji as animated. More...
select_option &	fill_from_json (nlohmann::json *j)
virtual std::string	build_json (bool with_id=false) const
	Build JSON string from the object. More...

Public Attributes
std::string	label
	User-facing name of the option. More...
std::string	value
	Dev-defined value of the option. More...
std::string	description
	Additional description of the option. More...
bool	is_default
	True if option is the default option. More...
struct dpp::select_option::inner_select_emoji	emoji

Detailed Description

An option for a select component.

Constructor & Destructor Documentation

select_option() [1/2]

dpp::select_option::select_option

(

)

Construct a new select option object.

~select_option()

virtual dpp::select_option::~select_option ( )

virtualdefault

Destructs the select option object.

select_option() [2/2]

dpp::select_option::select_option	(	const std::string &	label,
		const std::string &	value,
		const std::string &	description = ""
	)

Construct a new select option object.

Parameters

label	Label of option
value	Value of option
description	Description of option

Member Function Documentation

build_json()

virtual std::string dpp::json_interface< select_option >::build_json ( bool  with_id = false ) const

inlinevirtualinherited

Build JSON string from the object.

Parameters

with_id

Include the ID in the JSON

Returns

std::string JSON string version of object

fill_from_json()

select_option & dpp::select_option::fill_from_json

(

nlohmann::json *

j

)

Read class values from json object

Parameters

j	A json object to read from

Returns

A reference to self

set_animated()

select_option & dpp::select_option::set_animated

(

bool

anim

)

Set the emoji as animated.

Parameters

anim	true if animated

Returns

select_option& reference to self for chaining

set_default()

select_option & dpp::select_option::set_default

(

bool

def

)

Set the option as default.

Parameters

def	true to set the option as default

Returns

select_option& reference to self for chaining

set_description()

select_option & dpp::select_option::set_description

(

const std::string &

d

)

Set the description.

Parameters

d	description to set. It will be truncated to the maximum length of 100 UTF-8 characters.

Returns

select_option& reference to self for chaining

set_emoji()

select_option & dpp::select_option::set_emoji	(	const std::string &	n,
		dpp::snowflake	id = 0,
		bool	animated = false
	)

Set the emoji.

Parameters

n	emoji name
id	emoji id for custom emojis
animated	true if animated emoji

Returns

select_option& reference to self for chaining

set_label()

select_option & dpp::select_option::set_label

(

const std::string &

l

)

Set the label.

Parameters

l	the user-facing name of the option. It will be truncated to the maximum length of 100 UTF-8 characters.

Returns

select_option& reference to self for chaining

set_value()

select_option & dpp::select_option::set_value

(

const std::string &

v

)

Set the value.

Parameters

v	value to set. It will be truncated to the maximum length of 100 UTF-8 characters.

Returns

select_option& reference to self for chaining

Member Data Documentation

description

std::string dpp::select_option::description

Additional description of the option.

emoji

struct dpp::select_option::inner_select_emoji dpp::select_option::emoji

is_default

bool dpp::select_option::is_default

True if option is the default option.

label

std::string dpp::select_option::label

User-facing name of the option.

value

std::string dpp::select_option::value

Dev-defined value of the option.