Execute/trigger automod rule. More...

Inheritance diagram for dpp::automod_rule_execute_t:

Collaboration diagram for dpp::automod_rule_execute_t:

Public Member Functions
	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 (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 &	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...

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

event_dispatch_t &	cancel_event ()
	Cancels the event in progress. Any other attached lambdas for this event after this one are not called. 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
snowflake	guild_id = {}
	The id of the guild in which action was executed. More...

automod_action	action = {}
	The action which was executed. 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...

snowflake	channel_id = {}
	Optional: the id of the channel in which user content was posted. More...

snowflake	message_id = {}
	Optional: the id of any user message which content belongs to. More...

snowflake	alert_system_message_id = {}
	Optional: the id of any system auto moderation messages posted as a result of this action. More...

std::string	content = {}
	The user generated text content. More...

std::string	matched_keyword = {}
	The word or phrase configured in the rule that triggered the rule (may be empty). More...

std::string	matched_content = {}
	The substring in content that triggered the rule (may be empty). More...

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

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

bool	cancelled = false
	Whether the event was cancelled using cancel_event(). More...

Detailed Description

Execute/trigger automod rule.

Member Function Documentation

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.

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.