dpp::form_submit_t Struct Reference

#include <dispatcher.h>

Inheritance diagram for dpp::form_submit_t:

Collaboration diagram for dpp::form_submit_t:

Public Member Functions
	form_submit_t (class discord_client *client, const std::string &raw)
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, command_completion_event_t callback={}) const
	Send a reply for this interaction. More...
void	reply (interaction_response_type t, const std::string &mt, command_completion_event_t callback={}) const
	Send a reply for this interaction. More...
void	dialog (const interaction_modal_response &mr, command_completion_event_t callback={}) const
	Reply to interaction with a dialog box. More...
void	get_original_response (command_completion_event_t callback) const
	Get original response message for this interaction. More...
void	edit_response (const message &m, command_completion_event_t callback={}) const
	Edit the response for this interaction. More...
void	edit_response (const std::string &mt, command_completion_event_t callback={}) const
	Edit the response for this interaction. More...
void	delete_original_response (command_completion_event_t callback={})
	Delete the original response for this interaction. More...
void	thinking (command_completion_event_t callback={}) const
	Set the bot to 'thinking' state. More...
const event_dispatch_t &	cancel_event () const
	Cancels the event in progress. Any other attached lambdas for this event after this one are not called. Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state). More...
bool	is_cancelled () const
	Returns true if the event is cancelled. Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state). More...

Public Attributes
std::string	custom_id
	button custom id More...
std::vector< component >	components
	Message components for form reply. More...
interaction	command
	command interaction More...
const std::string	raw_event
	Raw event data. If you are using json on your websocket, this will contain json, and if you are using ETF as your websocket protocol, it will contain raw ETF data. More...
class discord_client *	from
	Shard the event came from. Note that for some events, notably voice events, this may be nullptr. More...

Constructor & Destructor Documentation

form_submit_t()

dpp::form_submit_t::form_submit_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

cancel_event()

const event_dispatch_t & dpp::event_dispatch_t::cancel_event ( ) const

inherited

Cancels the event in progress. Any other attached lambdas for this event after this one are not called. Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state).

Returns

const event_dispatch_t& reference to self for chaining

delete_original_response()

void dpp::interaction_create_t::delete_original_response ( command_completion_event_t  callback = {} )

inherited

Delete the original response for this interaction.

Parameters

callback

User function to execute when the api call completes. On success the callback will contain a dpp::confirmation 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().

dialog()

void dpp::interaction_create_t::dialog ( const interaction_modal_response &  mr, command_completion_event_t  callback = {}  ) const

inherited

Reply to interaction with a dialog box.

Note

Experimental

Parameters

mr	Dialog box response to send
callback	User function to execute when the api call completes. On success the callback will contain a dpp::confirmation 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().

edit_response() [1/2]

void dpp::interaction_create_t::edit_response ( const message &  m, command_completion_event_t  callback = {}  ) const

inherited

Edit the response for this interaction.

Parameters

m	Message object to send. Not all fields are supported by Discord.
callback	User function to execute when the api call completes. On success the callback will contain a dpp::confirmation 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().

edit_response() [2/2]

void dpp::interaction_create_t::edit_response ( const std::string &  mt, command_completion_event_t  callback = {}  ) const

inherited

Edit the response for this interaction.

Parameters

mt	The string value to send, for simple text only messages
callback	User function to execute when the api call completes. On success the callback will contain a dpp::confirmation 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_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::form_submit_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.

is_cancelled()

bool dpp::event_dispatch_t::is_cancelled ( ) const

inherited

Returns true if the event is cancelled. Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state).

Returns

true if the event is cancelled

reply() [1/2]

void dpp::interaction_create_t::reply ( interaction_response_type  t, const message &  m, command_completion_event_t  callback = {}  ) 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.
callback	User function to execute when the api call completes. On success the callback will contain a dpp::confirmation 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().

reply() [2/2]

void dpp::interaction_create_t::reply ( interaction_response_type  t, const std::string &  mt, command_completion_event_t  callback = {}  ) 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
callback	User function to execute when the api call completes. On success the callback will contain a dpp::confirmation 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().

thinking()

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

inherited

Set the bot to 'thinking' state.

Parameters

callback

User function to execute when the api call completes. On success the callback will contain a dpp::confirmation 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().

Member Data Documentation

command

interaction dpp::interaction_create_t::command

inherited

command interaction

components

std::vector<component> dpp::form_submit_t::components

Message components for form reply.

custom_id

std::string dpp::form_submit_t::custom_id

button custom id

from

class discord_client* dpp::event_dispatch_t::from

inherited

Shard the event came from. Note that for some events, notably voice events, this may be nullptr.

raw_event

const std::string dpp::event_dispatch_t::raw_event

inherited

Raw event data. If you are using json on your websocket, this will contain json, and if you are using ETF as your websocket protocol, it will contain raw ETF data.