Event parameter for context menu interactions for users. More...

#include <dispatcher.h>

Inheritance diagram for dpp::user_context_menu_t:

Collaboration diagram for dpp::user_context_menu_t:

Public Member Functions
	user_context_menu_t (class discord_client *client, const std::string &raw)

user	get_user () const
	Get the user which was right-clicked on. More...

user_context_menu_t &	set_user (const user &u)
	Set the user object for this event. More...

void	reply (command_completion_event_t callback=utility::log_error()) const
	Acknowledge interaction without displaying a message to the user, for use with button and select menu components. More...

void	reply (interaction_response_type t, const message &m, command_completion_event_t callback=utility::log_error()) const
	Send a reply for this interaction. More...

void	reply (interaction_response_type t, const std::string &mt, command_completion_event_t callback=utility::log_error()) const
	Send a reply for this interaction. More...

void	reply (const message &m, command_completion_event_t callback=utility::log_error()) const
	Send a reply for this interaction. Uses the default type of dpp::ir_channel_message_with_source, a simple message reply. More...

void	reply (const std::string &mt, command_completion_event_t callback=utility::log_error()) const
	Send a reply for this interaction. Uses the default type of dpp::ir_channel_message_with_source, a simple message reply. More...

void	dialog (const interaction_modal_response &mr, command_completion_event_t callback=utility::log_error()) const
	Reply to interaction with a dialog box. More...

void	edit_response (const message &m, command_completion_event_t callback=utility::log_error()) const
	Edit the response for this interaction. More...

void	edit_response (const std::string &mt, command_completion_event_t callback=utility::log_error()) const
	Edit the response for this interaction. More...

void	thinking (bool ephemeral=false, command_completion_event_t callback=utility::log_error()) const
	Set the bot to 'thinking' state. More...

void	get_original_response (command_completion_event_t callback) const
	Get original response message for this interaction. More...

void	edit_original_response (const message &m, command_completion_event_t callback=utility::log_error()) const
	Edit original response message for this interaction. More...

void	delete_original_response (command_completion_event_t callback=utility::log_error()) const
	Delete original response message for this interaction. This cannot be used on an ephemeral interaction response. More...

virtual const command_value &	get_parameter (const std::string &name) const
	Get a command line parameter. 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
user	ctx_user
	Related user. 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...

Detailed Description

Event parameter for context menu interactions for users.

Constructor & Destructor Documentation

◆ user_context_menu_t()

dpp::user_context_menu_t::user_context_menu_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 = utility::log_error() ) const

inherited

Delete original response message for this interaction. This cannot be used on an ephemeral interaction response.

Parameters

callback Function to call 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 = `utility::log_error()`
	)		const

inherited

Reply to interaction with a dialog box.

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_original_response()

void dpp::interaction_create_t::edit_original_response	(	const message &	m,
		command_completion_event_t	callback = `utility::log_error()`
	)		const

inherited

Edit original response message for this interaction.

Parameters

m	Message object to send. Not all fields are supported by Discord.
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().

◆ edit_response() [1/2]

void dpp::interaction_create_t::edit_response	(	const message &	m,
		command_completion_event_t	callback = `utility::log_error()`
	)		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 = `utility::log_error()`
	)		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::interaction_create_t::get_parameter ( const std::string & name ) const

virtualinherited

Get a command line parameter.

Parameters

name	The command line parameter to retrieve

Returns: const command_value& If the command line parameter does not exist, an empty variant is returned.

Reimplemented in dpp::button_click_t, dpp::form_submit_t, dpp::autocomplete_t, and dpp::select_click_t.

◆ get_user()

user dpp::user_context_menu_t::get_user ( ) const

Get the user which was right-clicked on.

Returns: user right clicked on

◆ 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/5]

void dpp::interaction_create_t::reply ( command_completion_event_t callback = utility::log_error() ) const

inherited

Acknowledge interaction without displaying a message to the user, for use with button and select menu components.

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().

◆ reply() [2/5]

void dpp::interaction_create_t::reply	(	const message &	m,
		command_completion_event_t	callback = `utility::log_error()`
	)		const

inherited

Send a reply for this interaction. Uses the default type of dpp::ir_channel_message_with_source, a simple message reply.

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().

◆ reply() [3/5]

void dpp::interaction_create_t::reply	(	const std::string &	mt,
		command_completion_event_t	callback = `utility::log_error()`
	)		const

inherited

Send a reply for this interaction. Uses the default type of dpp::ir_channel_message_with_source, a simple message reply.

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().

◆ reply() [4/5]

void dpp::interaction_create_t::reply	(	interaction_response_type	t,
		const message &	m,
		command_completion_event_t	callback = `utility::log_error()`
	)		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() [5/5]

void dpp::interaction_create_t::reply	(	interaction_response_type	t,
		const std::string &	mt,
		command_completion_event_t	callback = `utility::log_error()`
	)		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().

◆ set_user()

user_context_menu_t & dpp::user_context_menu_t::set_user ( const user & u )

Set the user object for this event.

Parameters

u	user to set

Returns: user_context_menu_t& reference to self for fluent chaining

◆ thinking()

void dpp::interaction_create_t::thinking	(	bool	ephemeral = `false`,
		command_completion_event_t	callback = `utility::log_error()`
	)		const

inherited

Set the bot to 'thinking' state.

Parameters

ephemeral	True if the thinking state should be ephemeral
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

◆ ctx_user

user dpp::user_context_menu_t::ctx_user

Related user.

◆ 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.

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ user_context_menu_t()

Member Function Documentation

◆ cancel_event()

◆ delete_original_response()

◆ dialog()

◆ edit_original_response()

◆ edit_response() [1/2]

◆ edit_response() [2/2]

◆ get_original_response()

◆ get_parameter()

◆ get_user()

◆ is_cancelled()

◆ reply() [1/5]

◆ reply() [2/5]

◆ reply() [3/5]

◆ reply() [4/5]

◆ reply() [5/5]

◆ set_user()

◆ thinking()

Member Data Documentation

◆ command

◆ ctx_user

◆ from

◆ raw_event