dpp::message_create_t Struct Reference

Create message. More...

#include "dispatcher.h"

Inheritance diagram for dpp::message_create_t:

Collaboration diagram for dpp::message_create_t:

Public Member Functions
event_dispatch_t &	cancel_event ()
	Cancels the event in progress. More...
const event_dispatch_t &	cancel_event () const
	Cancels the event in progress. More...
	event_dispatch_t ()=default
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (const event_dispatch_t &rhs)=default
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (discord_client *client, const std::string &raw)
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (discord_client *client, std::string &&raw)
	Construct a new event_dispatch_t object. More...
	event_dispatch_t (event_dispatch_t &&rhs)=default
	Construct a new event_dispatch_t object. More...
bool	is_cancelled () const
	Returns true if the event is cancelled. More...
event_dispatch_t &	operator= (const event_dispatch_t &rhs)=default
	Copy another event_dispatch_t object. More...
event_dispatch_t &	operator= (event_dispatch_t &&rhs)=default
	Move from another event_dispatch_t object. More...
void	reply (const message &msg, bool mention_replied_user=false, command_completion_event_t callback=utility::log_error()) const
	Reply to the message received in the event. More...
void	reply (const std::string &m, bool mention_replied_user=false, command_completion_event_t callback=utility::log_error()) const
	Reply to the message received in the event. More...
void	reply (message &&msg, bool mention_replied_user=false, command_completion_event_t callback=utility::log_error()) const
	Reply to the message received in the event. More...
void	send (const message &msg, command_completion_event_t callback=utility::log_error()) const
	Send a message to the same channel as the channel_id in received event. More...
void	send (const std::string &m, command_completion_event_t callback=utility::log_error()) const
	Send a text to the same channel as the channel_id in received event. More...
void	send (message &&msg, command_completion_event_t callback=utility::log_error()) const
	Send a message to the same channel as the channel_id in received event. More...

Public Attributes
bool	cancelled = false
	Whether the event was cancelled using cancel_event(). More...
discord_client *	from = nullptr
	Shard the event came from. More...
message	msg = {}
	message that was created (sent). More...
std::string	raw_event = {}
	Raw event data. More...

Detailed Description

Create message.

Member Function Documentation

cancel_event() [1/2]

event_dispatch_t& dpp::event_dispatch_t::cancel_event ( )

inherited

Cancels the event in progress.

Any other attached lambdas for this event after this one are not called.

Warning

This will modify the event object in a non-thread-safe manner.

Returns

const event_dispatch_t& reference to self for chaining

cancel_event() [2/2]

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.

Warning

This will modify the event object in a non-thread-safe manner.

Returns

const event_dispatch_t& reference to self for chaining

event_dispatch_t() [1/5]

dpp::event_dispatch_t::event_dispatch_t

default

Construct a new event_dispatch_t object.

event_dispatch_t() [2/5]

dpp::event_dispatch_t::event_dispatch_t

default

Construct a new event_dispatch_t object.

Parameters

rhs	event_dispatch_t object to copy from

event_dispatch_t() [3/5]

dpp::event_dispatch_t::event_dispatch_t

Construct a new event_dispatch_t object.

Parameters

client	The shard the event originated on. May be a nullptr, e.g. for voice events
raw	Raw event data as JSON or ETF

event_dispatch_t() [4/5]

dpp::event_dispatch_t::event_dispatch_t

Construct a new event_dispatch_t object.

Parameters

client	The shard the event originated on. May be a nullptr, e.g. for voice events
raw	Raw event data as JSON or ETF

event_dispatch_t() [5/5]

dpp::event_dispatch_t::event_dispatch_t

default

Construct a new event_dispatch_t object.

Parameters

rhs	event_dispatch_t object to move from

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

operator=() [1/2]

event_dispatch_t& dpp::event_dispatch_t::operator=

default

Copy another event_dispatch_t object.

Parameters

rhs	The event to copy from

operator=() [2/2]

event_dispatch_t& dpp::event_dispatch_t::operator=

default

Move from another event_dispatch_t object.

Parameters

rhs	The event to move from

reply() [1/3]

void dpp::message_create_t::reply	(	const message &	msg,
		bool	mention_replied_user = false,
		command_completion_event_t	callback = utility::log_error()
	)		const

Reply to the message received in the event.

Parameters

msg	Message to send as a reply.
mention_replied_user	mentions (pings) the author of message replied to, if true
callback	User function to execute once the API call completes.

Note

confirmation_callback_t::value contains a message object on success. On failure, value is undefined and confirmation_callback_t::is_error() is true.

reply() [2/3]

void dpp::message_create_t::reply	(	const std::string &	m,
		bool	mention_replied_user = false,
		command_completion_event_t	callback = utility::log_error()
	)		const

Reply to the message received in the event.

Parameters

m	Text to send
mention_replied_user	mentions (pings) the author of message replied to, if true
callback	User function to execute once the API call completes.

Note

confirmation_callback_t::value contains a message object on success. On failure, value is undefined and confirmation_callback_t::is_error() is true.

reply() [3/3]

void dpp::message_create_t::reply	(	message &&	msg,
		bool	mention_replied_user = false,
		command_completion_event_t	callback = utility::log_error()
	)		const

Reply to the message received in the event.

Parameters

msg	Message to send as a reply.
mention_replied_user	mentions (pings) the author of message replied to, if true
callback	User function to execute once the API call completes.

Note

confirmation_callback_t::value contains a message object on success. On failure, value is undefined and confirmation_callback_t::is_error() is true.

send() [1/3]

void dpp::message_create_t::send	(	const message &	msg,
		command_completion_event_t	callback = utility::log_error()
	)		const

Send a message to the same channel as the channel_id in received event.

Parameters

msg	Message to send
callback	User function to execute once the API call completes.

Note

confirmation_callback_t::value contains a message object on success. On failure, value is undefined and confirmation_callback_t::is_error() is true.

send() [2/3]

void dpp::message_create_t::send	(	const std::string &	m,
		command_completion_event_t	callback = utility::log_error()
	)		const

Send a text to the same channel as the channel_id in received event.

Parameters

m	Text to send
callback	User function to execute once the API call completes.

Note

confirmation_callback_t::value contains a message object on success. On failure, value is undefined and confirmation_callback_t::is_error() is true.

send() [3/3]

void dpp::message_create_t::send	(	message &&	msg,
		command_completion_event_t	callback = utility::log_error()
	)		const

Send a message to the same channel as the channel_id in received event.

Parameters

msg	Message to send
callback	User function to execute once the API call completes.

Note

confirmation_callback_t::value contains a message object on success. On failure, value is undefined and confirmation_callback_t::is_error() is true.

References dpp::message::channel_id, msg, and dpp::message::set_reference().

Here is the call graph for this function:

Member Data Documentation

cancelled

bool dpp::event_dispatch_t::cancelled = false

mutableinherited

Whether the event was cancelled using cancel_event().

from

discord_client* dpp::event_dispatch_t::from = nullptr

inherited

Shard the event came from.

Note that for some events, notably voice events, this may be nullptr.

Referenced by dpp::interaction_create_t::dialog().

msg

message dpp::message_create_t::msg = {}

message that was created (sent).

Referenced by event_handler_test(), dpp::commandhandler::route(), send(), dpp::message_context_menu_t::set_message(), and dpp::commandhandler::string_has_prefix().

raw_event

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.

---

The documentation for this struct was generated from the following files:

• dispatcher.h
• dispatcher.cpp