dpp::automod_rule_execute_t Struct Reference

Execute/trigger automod rule. More...

#include <dispatcher.h>

Inheritance diagram for dpp::automod_rule_execute_t:

Collaboration diagram for dpp::automod_rule_execute_t:

Public Member Functions
	automod_rule_execute_t (class discord_client *client, const std::string &raw)
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
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...
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

Execute/trigger automod rule.

Constructor & Destructor Documentation

automod_rule_execute_t()

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

Constructor

Parameters

client	The shard the event originated on. CAN BE NULL for log events originating from the cluster object
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

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

Member Data Documentation

action

automod_action dpp::automod_rule_execute_t::action

the action which was executed

alert_system_message_id

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.

channel_id

snowflake dpp::automod_rule_execute_t::channel_id

Optional: the id of the channel in which user content was posted.

content

std::string dpp::automod_rule_execute_t::content

the user generated text content

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.

guild_id

snowflake dpp::automod_rule_execute_t::guild_id

the id of the guild in which action was executed

matched_content

std::string dpp::automod_rule_execute_t::matched_content

the substring in content that triggered the rule (may be empty)

matched_keyword

std::string dpp::automod_rule_execute_t::matched_keyword

the word or phrase configured in the rule that triggered the rule (may be empty)

message_id

snowflake dpp::automod_rule_execute_t::message_id

Optional: the id of any user message which content belongs to.

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.

rule_id

snowflake dpp::automod_rule_execute_t::rule_id

the id of the rule which action belongs to

rule_trigger_type

automod_trigger_type dpp::automod_rule_execute_t::rule_trigger_type

the trigger type of rule which was triggered

user_id

snowflake dpp::automod_rule_execute_t::user_id

the id of the user which generated the content which triggered the rule