D++ (DPP)
C++ Discord API Bot Library
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

 message_create_t (class discord_client *client, const std::string &raw)
 
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...
 
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...
 
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 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...
 
const event_dispatch_tcancel_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

message msg
 message that was created (sent). 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_clientfrom
 Shard the event came from. Note that for some events, notably voice events, this may be nullptr. More...
 

Detailed Description

Create message.

Constructor & Destructor Documentation

◆ message_create_t()

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

Constructor

Parameters
clientThe shard the event originated on
rawRaw 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

◆ 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/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
mText to send
mention_replied_usermentions (pings) the author of message replied to, if true
callbackUser 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 ( 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
msgMessage to send as a reply.
mention_replied_usermentions (pings) the author of message replied to, if true
callbackUser 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
msgMessage to send as a reply.
mention_replied_usermentions (pings) the author of message replied to, if true
callbackUser 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 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
mText to send
callbackUser 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 ( 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
msgMessage to send
callbackUser 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
msgMessage to send
callbackUser 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.

Member Data Documentation

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

◆ msg

message dpp::message_create_t::msg

message that was created (sent).

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

D++ Library version 10.0.21D++ Library version 10.0.20D++ Library version 10.0.19D++ Library version 10.0.18D++ Library version 10.0.17D++ Library version 10.0.16D++ Library version 10.0.15D++ Library version 10.0.14D++ Library version 10.0.13D++ Library version 10.0.12D++ Library version 10.0.11D++ Library version 10.0.10D++ Library version 10.0.9D++ Library version 10.0.8D++ Library version 10.0.7D++ Library version 10.0.6D++ Library version 10.0.5D++ Library version 10.0.4D++ Library version 10.0.3D++ Library version 10.0.2D++ Library version 10.0.1D++ Library version 10.0.0D++ Library version 9.0.19D++ Library version 9.0.18D++ Library version 9.0.17D++ Library version 9.0.16D++ Library version 9.0.15D++ Library version 9.0.14D++ Library version 9.0.13D++ Library version 9.0.12D++ Library version 9.0.11D++ Library version 9.0.10D++ Library version 9.0.9D++ Library version 9.0.8D++ Library version 9.0.7D++ Library version 9.0.6D++ Library version 9.0.5D++ Library version 9.0.4D++ Library version 9.0.3D++ Library version 9.0.2D++ Library version 9.0.1D++ Library version 9.0.0D++ Library version 1.0.2D++ Library version 1.0.1D++ Library version 1.0.0