Execute/trigger automod rule. More...
#include "dispatcher.h"
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... | |
Public Attributes | |
automod_action | action = {} |
The action which was executed. More... | |
snowflake | alert_system_message_id = {} |
Optional: the id of any system auto moderation messages posted as a result of this action. More... | |
bool | cancelled = false |
Whether the event was cancelled using cancel_event(). More... | |
snowflake | channel_id = {} |
Optional: the id of the channel in which user content was posted. More... | |
std::string | content = {} |
The user generated text content. More... | |
discord_client * | from = nullptr |
Shard the event came from. More... | |
snowflake | guild_id = {} |
The id of the guild in which action was executed. More... | |
std::string | matched_content = {} |
The substring in content that triggered the rule (may be empty). More... | |
std::string | matched_keyword = {} |
The word or phrase configured in the rule that triggered the rule (may be empty). More... | |
snowflake | message_id = {} |
Optional: the id of any user message which content belongs to. More... | |
std::string | raw_event = {} |
Raw event data. More... | |
snowflake | rule_id = {} |
The id of the rule which action belongs to. More... | |
automod_trigger_type | rule_trigger_type = {} |
The trigger type of rule which was triggered. More... | |
snowflake | user_id = {} |
The id of the user which generated the content which triggered the rule. More... | |
Execute/trigger automod rule.
|
inherited |
Cancels the event in progress.
Any other attached lambdas for this event after this one are not called.
|
inherited |
Cancels the event in progress.
Any other attached lambdas for this event after this one are not called.
|
default |
Construct a new event_dispatch_t object.
|
default |
Construct a new event_dispatch_t object.
rhs | event_dispatch_t object to copy from |
dpp::event_dispatch_t::event_dispatch_t |
Construct a new event_dispatch_t object.
client | The shard the event originated on. May be a nullptr, e.g. for voice events |
raw | Raw event data as JSON or ETF |
dpp::event_dispatch_t::event_dispatch_t |
Construct a new event_dispatch_t object.
client | The shard the event originated on. May be a nullptr, e.g. for voice events |
raw | Raw event data as JSON or ETF |
|
default |
Construct a new event_dispatch_t object.
rhs | event_dispatch_t object to move from |
|
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).
|
default |
Copy another event_dispatch_t object.
rhs | The event to copy from |
|
default |
Move from another event_dispatch_t object.
rhs | The event to move from |
automod_action dpp::automod_rule_execute_t::action = {} |
The action which was executed.
snowflake dpp::automod_rule_execute_t::alert_system_message_id = {} |
Optional: the id of any system auto moderation messages posted as a result of this action.
|
mutableinherited |
Whether the event was cancelled using cancel_event().
snowflake dpp::automod_rule_execute_t::channel_id = {} |
Optional: the id of the channel in which user content was posted.
std::string dpp::automod_rule_execute_t::content = {} |
The user generated text content.
|
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().
snowflake dpp::automod_rule_execute_t::guild_id = {} |
The id of the guild in which action was executed.
std::string dpp::automod_rule_execute_t::matched_content = {} |
The substring in content that triggered the rule (may be empty).
std::string dpp::automod_rule_execute_t::matched_keyword = {} |
The word or phrase configured in the rule that triggered the rule (may be empty).
snowflake dpp::automod_rule_execute_t::message_id = {} |
Optional: the id of any user message which content belongs to.
|
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.
snowflake dpp::automod_rule_execute_t::rule_id = {} |
The id of the rule which action belongs to.
automod_trigger_type dpp::automod_rule_execute_t::rule_trigger_type = {} |
The trigger type of rule which was triggered.
snowflake dpp::automod_rule_execute_t::user_id = {} |
The id of the user which generated the content which triggered the rule.