dpp::command_option Struct Reference

Each command option is a command line parameter. It can have a type (see dpp::command_option_type), a name, a description, can be required or optional, and can have zero or more choices (for multiple choice), plus options. Adding options acts like sub-commands and can contain more options. More...

#include <appcommand.h>

Inheritance diagram for dpp::command_option:

Collaboration diagram for dpp::command_option:

Public Member Functions
	command_option ()=default
	Construct a new command option object. More...
virtual	~command_option ()=default
	command_option (command_option_type t, const std::string &name, const std::string &description, bool required=false)
	Construct a new command option object. More...
command_option &	add_choice (const command_option_choice &o)
	Add a multiple choice option. More...
command_option &	set_min_value (command_option_range min_v)
	Set the minimum numeric value of the option. Only valid if the type is co_number or co_integer. More...
command_option &	set_max_value (command_option_range max_v)
	Set the maximum numeric value of the option. Only valid if the type is co_number or co_integer. More...
command_option &	add_option (const command_option &o)
	Add a sub-command option. More...
command_option &	add_channel_type (const channel_type ch)
	Add channel type for option (only for co_channel type options) More...
command_option &	set_auto_complete (bool autocomp)
	Set the auto complete state. More...
command_option &	fill_from_json (nlohmann::json *j)
	Fill object properties from JSON. Fills options recursively. More...
command_option &	parse_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. More...
virtual std::string	build_json (bool with_id=false) const
	Build JSON string from the object. More...

Public Attributes
command_option_type	type
	Option type (what type of value is accepted) More...
std::string	name
	Option name (1-32 chars) More...
std::string	description
	Option description (1-100 chars) More...
bool	required
	True if this is a mandatory parameter. More...
bool	focused
	True if the user is typing in this field, when sent via autocomplete. More...
command_value	value
	Set only by autocomplete went sent as part of an interaction. More...
std::vector< command_option_choice >	choices
	List of choices for multiple choice command. More...
bool	autocomplete
	True if this option supports auto completion. More...
std::vector< command_option >	options
	Sub-commands. More...
std::vector< channel_type >	channel_types
	Allowed channel types for channel snowflake id options. More...
command_option_range	min_value
	Minimum value allowed, for co_number and co_integer types only. More...
command_option_range	max_value
	Maximum value allowed, for co_number and co_integer types only. More...

Detailed Description

Each command option is a command line parameter. It can have a type (see dpp::command_option_type), a name, a description, can be required or optional, and can have zero or more choices (for multiple choice), plus options. Adding options acts like sub-commands and can contain more options.

Constructor & Destructor Documentation

command_option() [1/2]

dpp::command_option::command_option ( )

default

Construct a new command option object.

~command_option()

virtual dpp::command_option::~command_option ( )

virtualdefault

command_option() [2/2]

dpp::command_option::command_option	(	command_option_type	t,
		const std::string &	name,
		const std::string &	description,
		bool	required = false
	)

Construct a new command option object.

Parameters

t	Option type
name	Option name
description	Option description
required	True if this is a mandatory parameter

Member Function Documentation

add_channel_type()

command_option & dpp::command_option::add_channel_type

(

const channel_type

ch

)

Add channel type for option (only for co_channel type options)

Parameters

ch	type to set

Returns

command_option& return a reference to self for chaining of calls

add_choice()

command_option & dpp::command_option::add_choice

(

const command_option_choice &

o

)

Add a multiple choice option.

Parameters

o	choice to add

Returns

command_option& returns a reference to self for chaining of calls

Exceptions

dpp::exception

command_option is an autocomplete, so choices cannot be added

add_option()

command_option & dpp::command_option::add_option

(

const command_option &

o

)

Add a sub-command option.

Parameters

o	Sub-command option to add

Returns

command_option& return a reference to self for chaining of calls

build_json()

virtual std::string dpp::json_interface< command_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()

command_option & dpp::command_option::fill_from_json

(

nlohmann::json *

j

)

Fill object properties from JSON. Fills options recursively.

Parameters

j	JSON to fill from

Returns

command_option& Reference to self

parse_from_json()

command_option & dpp::json_interface< command_option >::parse_from_json ( nlohmann::json *  j )

inlineinherited

Convert object from nlohmann::json.

Parameters

j	nlohmann::json object

Returns

T& Reference to self for fluent calling

set_auto_complete()

command_option & dpp::command_option::set_auto_complete

(

bool

autocomp

)

Set the auto complete state.

Parameters

autocomp

True to enable auto completion for this option

Returns

command_option& return a reference to self for chaining of calls

Exceptions

dpp::exception

You attempted to enable auto complete on a command_option that has choices added to it

set_max_value()

command_option & dpp::command_option::set_max_value

(

command_option_range

max_v

)

Set the maximum numeric value of the option. Only valid if the type is co_number or co_integer.

Parameters

max_v

Maximum value

Returns

command_option& return a reference to sef for chaining of calls

set_min_value()

command_option & dpp::command_option::set_min_value

(

command_option_range

min_v

)

Set the minimum numeric value of the option. Only valid if the type is co_number or co_integer.

Parameters

min_v

Minimum value

Returns

command_option& return a reference to sef for chaining of calls

Member Data Documentation

autocomplete

bool dpp::command_option::autocomplete

True if this option supports auto completion.

channel_types

std::vector<channel_type> dpp::command_option::channel_types

Allowed channel types for channel snowflake id options.

choices

std::vector<command_option_choice> dpp::command_option::choices

List of choices for multiple choice command.

description

std::string dpp::command_option::description

Option description (1-100 chars)

focused

bool dpp::command_option::focused

True if the user is typing in this field, when sent via autocomplete.

max_value

command_option_range dpp::command_option::max_value

Maximum value allowed, for co_number and co_integer types only.

min_value

command_option_range dpp::command_option::min_value

Minimum value allowed, for co_number and co_integer types only.

name

std::string dpp::command_option::name

Option name (1-32 chars)

options

std::vector<command_option> dpp::command_option::options

Sub-commands.

required

bool dpp::command_option::required

True if this is a mandatory parameter.

type

command_option_type dpp::command_option::type

Option type (what type of value is accepted)

value

command_value dpp::command_option::value

Set only by autocomplete went sent as part of an interaction.