dpp::button_click_t Struct Reference

Click on button. More...

#include <dispatcher.h>

Inheritance diagram for dpp::button_click_t:

Collaboration diagram for dpp::button_click_t:

Public Member Functions
	button_click_t (class discord_client *client, const std::string &raw)
void	edit_response (const message &m) const
	Edit the response for this interaction. More...
void	edit_response (const std::string &mt) const
	Edit the response for this interaction. More...
void	get_original_response (command_completion_event_t callback={}) const
	Get original response message for this interaction. More...
virtual const command_value &	get_parameter (const std::string &name) const
	Get a command line parameter. More...
void	reply (interaction_response_type t, const message &m) const
	Send a reply for this interaction. More...
void	reply (interaction_response_type t, const std::string &mt) const
	Send a reply for this interaction. More...

Public Attributes
interaction	command
uint8_t	component_type
std::string	custom_id
class discord_client *	from
std::string	raw_event

Detailed Description

Click on button.

Constructor & Destructor Documentation

button_click_t()

dpp::button_click_t::button_click_t	(	class discord_client *	client,
		const std::string &	raw
	)

Constructor

Parameters

client	The shard the event originated on
raw	Raw event text as JSON

Member Function Documentation

edit_response() [1/2]

void dpp::interaction_create_t::edit_response ( const message &  m ) const

inherited

Edit the response for this interaction.

Parameters

m	Message object to send. Not all fields are supported by Discord.

edit_response() [2/2]

void dpp::interaction_create_t::edit_response ( const std::string &  mt ) const

inherited

Edit the response for this interaction.

Parameters

mt	The string value to send, for simple text only messages

get_original_response()

void dpp::interaction_create_t::get_original_response ( command_completion_event_t  callback = {} ) const

inherited

Get original response message for this interaction.

Parameters

callback

Function to call when the API call completes. On success the callback will contain a dpp::message object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

get_parameter()

virtual const command_value & dpp::button_click_t::get_parameter ( const std::string &  name ) const

virtual

Get a command line parameter.

Parameters

name	The command line parameter to retrieve

Returns

Always returns an empty parameter as buttons dont have parameters!

Reimplemented from dpp::interaction_create_t.

reply() [1/2]

void dpp::interaction_create_t::reply ( interaction_response_type  t, const message &  m  ) const

inherited

Send a reply for this interaction.

Parameters

t	Type of reply to send
m	Message object to send. Not all fields are supported by Discord.

reply() [2/2]

void dpp::interaction_create_t::reply ( interaction_response_type  t, const std::string &  mt  ) const

inherited

Send a reply for this interaction.

Parameters

t	Type of reply to send
mt	The string value to send, for simple text only messages

Member Data Documentation

command

interaction dpp::interaction_create_t::command

inherited

component_type

uint8_t dpp::button_click_t::component_type

custom_id

std::string dpp::button_click_t::custom_id

from

class discord_client* dpp::event_dispatch_t::from

inherited

Shard the event came from

raw_event

std::string dpp::event_dispatch_t::raw_event

inherited

Raw event text