D++ (DPP)
C++ Discord API Bot Library
dpp::param_info Struct Reference

Details of a command parameter used in registration. Note that for non-slash commands optional parameters can only be at the end of the list of parameters. More...

+ Collaboration diagram for dpp::param_info:

Public Member Functions

 param_info (parameter_type t, bool o, const std::string &description, const std::map< command_value, std::string > &opts={})
 Construct a new param_info object. More...
 

Public Attributes

parameter_type type
 Type of parameter. More...
 
bool optional
 True if the parameter is optional. For non-slash commands optional parameters may only be on the end of the list. More...
 
std::string description
 Description of command. Displayed only for slash commands. More...
 
std::map< command_value, std::string > choices
 Allowed multiple choice options. The key name is the string passed to the command handler and the key value is its description displayed to the user. More...
 

Detailed Description

Details of a command parameter used in registration. Note that for non-slash commands optional parameters can only be at the end of the list of parameters.

Constructor & Destructor Documentation

◆ param_info()

dpp::param_info::param_info ( parameter_type  t,
bool  o,
const std::string &  description,
const std::map< command_value, std::string > &  opts = {} 
)

Construct a new param_info object.

Parameters
tType of parameter
oTrue if parameter is optional
descriptionThe parameter description
optsThe options for a multiple choice parameter

Member Data Documentation

◆ choices

std::map<command_value, std::string> dpp::param_info::choices

Allowed multiple choice options. The key name is the string passed to the command handler and the key value is its description displayed to the user.

◆ description

std::string dpp::param_info::description

Description of command. Displayed only for slash commands.

◆ optional

bool dpp::param_info::optional

True if the parameter is optional. For non-slash commands optional parameters may only be on the end of the list.

◆ type

parameter_type dpp::param_info::type

Type of parameter.

D++ Library version 9.0.13D++ Library version 9.0.12D++ Library version 9.0.11D++ Library version 9.0.10D++ Library version 9.0.9D++ Library version 9.0.8D++ Library version 9.0.7D++ Library version 9.0.6D++ Library version 9.0.5D++ Library version 9.0.4D++ Library version 9.0.3D++ Library version 9.0.2D++ Library version 9.0.1D++ Library version 9.0.0D++ Library version 1.0.2D++ Library version 1.0.1D++ Library version 1.0.0