dpp::audit_entry Struct Reference

An individual audit log entry. More...

#include <auditlog.h>

Inheritance diagram for dpp::audit_entry:

Collaboration diagram for dpp::audit_entry:

Public Member Functions
	audit_entry ()
virtual	~audit_entry ()=default
audit_entry &	fill_from_json (nlohmann::json *j)
virtual std::string	build_json (bool with_id=false) const
	Build JSON string from the object. More...

Public Attributes
snowflake	id
	id of the entry More...
snowflake	target_id
std::vector< audit_change >	changes
	Optional: changes made to the target_id. More...
snowflake	user_id
	the user or app that made the changes (may be empty) More...
audit_type	type
	type of action that occurred More...
std::optional< audit_extra >	extra
	Optional: additional info for certain action types. More...
std::string	reason
	Optional: the reason for the change (1-512 characters) More...

Detailed Description

An individual audit log entry.

Constructor & Destructor Documentation

audit_entry()

dpp::audit_entry::audit_entry

(

)

Constructor

~audit_entry()

virtual dpp::audit_entry::~audit_entry ( )

virtualdefault

Destructor

Member Function Documentation

build_json()

virtual std::string dpp::json_interface< audit_entry >::build_json ( bool  with_id = false ) const

inlinevirtualinherited

Build JSON string from the object.

Parameters

with_id

Include the ID in the JSON

Returns

std::string JSON string version of object

fill_from_json()

audit_entry & dpp::audit_entry::fill_from_json

(

nlohmann::json *

j

)

Read class values from json object

Parameters

j	A json object to read from

Returns

A reference to self

Member Data Documentation

changes

std::vector<audit_change> dpp::audit_entry::changes

Optional: changes made to the target_id.

extra

std::optional<audit_extra> dpp::audit_entry::extra

Optional: additional info for certain action types.

id

snowflake dpp::audit_entry::id

id of the entry

reason

std::string dpp::audit_entry::reason

Optional: the reason for the change (1-512 characters)

target_id

snowflake dpp::audit_entry::target_id

ID of the affected entity (webhook, user, role, etc.) (may be empty)

Note

For dpp::audit_type::aut_appcommand_permission_update updates, it's the command ID or the app ID

type

audit_type dpp::audit_entry::type

type of action that occurred

user_id

snowflake dpp::audit_entry::user_id

the user or app that made the changes (may be empty)