dpp::commandhandler Class Reference

The commandhandler class represents a group of commands, prefixed or slash commands with handling functions. More...

#include <commandhandler.h>

Collaboration diagram for dpp::commandhandler:

Public Member Functions
bool	string_has_prefix (std::string &str)
	Returns true if the string has a known prefix on the start. Modifies string to remove prefix if it returns true. More...
	commandhandler (class cluster *o, bool auto_hook_events=true, snowflake application_id=0)
	Construct a new commandhandler object. More...
	~commandhandler ()
	Destroy the commandhandler object. More...
commandhandler &	set_owner (class cluster *o)
	Set the application id after construction. More...
commandhandler &	add_prefix (const std::string &prefix)
	Add a prefix to the command handler. More...
commandhandler &	add_command (const std::string &command, const parameter_registration_t &parameters, command_handler handler, const std::string &description="", snowflake guild_id=0)
	Add a command to the command handler. More...
commandhandler &	register_commands ()
	Register all slash commands with Discord This method must be called at least once if you are using the "/" prefix to mark the end of commands being added to the handler. Note that this uses bulk registration and will replace any existing slash commands. More...
void	route (const struct dpp::message_create_t &event)
	Route a command from the on_message_create function. Call this method from within your on_message_create with the received dpp::message object if you have disabled automatic registration of events. More...
void	route (const struct slashcommand_t &event)
	Route a command from the on_slashcommand function. Call this method from your on_slashcommand with the received dpp::interaction_create_t object if you have disabled automatic registration of events. More...
void	reply (const dpp::message &m, command_source source, command_completion_event_t callback=utility::log_error())
	Reply to a command. You should use this method rather than cluster::message_create as the way you reply varies between slash commands and message commands. Note you should ALWAYS reply. Slash commands will emit an ugly error to the user if you do not emit some form of reply within 3 seconds. More...
void	thinking (command_source source, command_completion_event_t callback=utility::log_error())
	Reply to a command without a message, causing the discord client to display "Bot name is thinking...". The "thinking" message will persist for a maximum of 15 minutes. This counts as a reply for a slash command. Slash commands will emit an ugly error to the user if you do not emit some form of reply within 3 seconds. More...

Public Attributes
std::unordered_map< std::string, command_info_t >	commands
	Commands in the handler. More...
std::vector< std::string >	prefixes
	Valid prefixes. More...
bool	slash_commands_enabled
	Set to true automatically if one of the prefixes added is "/". More...
class cluster *	owner
	Cluster we are attached to for issuing REST calls. More...
snowflake	app_id
	Application ID. More...
event_handle	interactions
	Interaction event handle. More...
event_handle	messages
	Message event handle. More...

Detailed Description

The commandhandler class represents a group of commands, prefixed or slash commands with handling functions.

It can automatically register slash commands, and handle routing of messages and interactions to separated command handler functions.

Deprecated:

commandhandler and message commands are deprecated and dpp::slashcommand is encouraged as a replacement.

Constructor & Destructor Documentation

commandhandler()

dpp::commandhandler::commandhandler	(	class cluster *	o,
		bool	auto_hook_events = true,
		snowflake	application_id = 0
	)

Construct a new commandhandler object.

Parameters

o	Owning cluster to attach to
auto_hook_events	Set to true to automatically hook the on_slashcommand and on_message events. You should not need to set this to false unless you have a specific use case, as D++ supports multiple listeners to an event, so will allow the commandhandler to hook to your command events without disrupting other uses for the events you may have.
application_id	The application id of the bot. If not specified, the class will look within the cluster object and use cluster::me::id instead.

~commandhandler()

dpp::commandhandler::~commandhandler

(

)

Destroy the commandhandler object.

Member Function Documentation

add_command()

commandhandler & dpp::commandhandler::add_command	(	const std::string &	command,
		const parameter_registration_t &	parameters,
		command_handler	handler,
		const std::string &	description = "",
		snowflake	guild_id = 0
	)

Add a command to the command handler.

Parameters

command	Command to be handled. Note that if any one of your prefixes is "/" this will attempt to register a global command using the API and you will receive notification of this command via an interaction event.
handler	Handler function
parameters	Parameters to use for the command
description	The description of the command, shown for slash commands
guild_id	The guild ID to restrict the command to. For slash commands causes registration of a guild command as opposed to a global command.

Returns

commandhandler& reference to self

Exceptions

dpp::logic_exception

if application ID cannot be determined

add_prefix()

commandhandler & dpp::commandhandler::add_prefix

(

const std::string &

prefix

)

Add a prefix to the command handler.

Parameters

prefix

Prefix to be handled by the command handler

Returns

commandhandler& reference to self

register_commands()

commandhandler & dpp::commandhandler::register_commands

(

)

Register all slash commands with Discord This method must be called at least once if you are using the "/" prefix to mark the end of commands being added to the handler. Note that this uses bulk registration and will replace any existing slash commands.

Note that if you have previously registered your commands and they have not changed, you do not need to call this again. Discord retains a cache of previously added commands.

Returns

commandhandler& Reference to self for chaining method calls

reply()

void dpp::commandhandler::reply	(	const dpp::message &	m,
		command_source	source,
		command_completion_event_t	callback = utility::log_error()
	)

Reply to a command. You should use this method rather than cluster::message_create as the way you reply varies between slash commands and message commands. Note you should ALWAYS reply. Slash commands will emit an ugly error to the user if you do not emit some form of reply within 3 seconds.

Parameters

m	message to reply with.
source	source of the command
callback	User function to execute when the api call completes.

route() [1/2]

void dpp::commandhandler::route

(

const struct dpp::message_create_t &

event

)

Route a command from the on_message_create function. Call this method from within your on_message_create with the received dpp::message object if you have disabled automatic registration of events.

Parameters

event

message create event to parse

route() [2/2]

void dpp::commandhandler::route

(

const struct slashcommand_t &

event

)

Route a command from the on_slashcommand function. Call this method from your on_slashcommand with the received dpp::interaction_create_t object if you have disabled automatic registration of events.

Parameters

event

command interaction event to parse

set_owner()

commandhandler & dpp::commandhandler::set_owner

(

class cluster *

o

)

Set the application id after construction.

Parameters

o	Owning cluster to attach to

string_has_prefix()

bool dpp::commandhandler::string_has_prefix

(

std::string &

str

)

Returns true if the string has a known prefix on the start. Modifies string to remove prefix if it returns true.

Parameters

str	String to check and modify

Returns

true string contained a prefix, prefix removed from string

false string did not contain a prefix

thinking()

void dpp::commandhandler::thinking	(	command_source	source,
		command_completion_event_t	callback = utility::log_error()
	)

Reply to a command without a message, causing the discord client to display "Bot name is thinking...". The "thinking" message will persist for a maximum of 15 minutes. This counts as a reply for a slash command. Slash commands will emit an ugly error to the user if you do not emit some form of reply within 3 seconds.

Parameters

source	source of the command
callback	User function to execute when the api call completes.

Member Data Documentation

app_id

snowflake dpp::commandhandler::app_id

Application ID.

commands

std::unordered_map<std::string, command_info_t> dpp::commandhandler::commands

Commands in the handler.

interactions

event_handle dpp::commandhandler::interactions

Interaction event handle.

messages

event_handle dpp::commandhandler::messages

Message event handle.

owner

class cluster* dpp::commandhandler::owner

Cluster we are attached to for issuing REST calls.

prefixes

std::vector<std::string> dpp::commandhandler::prefixes

Valid prefixes.

slash_commands_enabled

bool dpp::commandhandler::slash_commands_enabled

Set to true automatically if one of the prefixes added is "/".