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 ()
	Constructor. More...
virtual	~audit_entry ()=default
	Destructor. More...
std::string	build_json (bool with_id=false) const
	Convert object to json string. More...
audit_entry &	fill_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. More...
auto	to_json (bool with_id=false) const
	Convert object to nlohmann::json. More...

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

Protected Member Functions
audit_entry &	fill_from_json_impl (nlohmann::json *j)
	Read class values from json object. More...

Friends
struct	json_interface< audit_entry >

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()

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

inlineinherited

Convert object to json string.

Parameters

with_id

Whether to include the ID or not

Note

Some fields are conditionally filled, do not rely on all fields being present

Returns

std::string Json built from the structure

fill_from_json()

audit_entry & dpp::json_interface< audit_entry >::fill_from_json ( nlohmann::json *  j )

inlineinherited

Convert object from nlohmann::json.

Parameters

j	nlohmann::json object

Returns

T& Reference to self for fluent calling

fill_from_json_impl()

audit_entry & dpp::audit_entry::fill_from_json_impl ( nlohmann::json *  j )

protected

Read class values from json object.

Parameters

j	A json object to read from

Returns

A reference to self

References dpp::audit_extra::application_id, dpp::audit_extra::automod_rule_name, dpp::audit_extra::automod_rule_trigger_type, dpp::audit_extra::channel_id, dpp::audit_extra::count, dpp::audit_extra::delete_member_days, extra, dpp::audit_extra::id, dpp::audit_extra::members_removed, dpp::audit_extra::message_id, dpp::unicode_emoji::o, dpp::audit_extra::role_name, dpp::snowflake_not_null(), dpp::string_not_null(), and dpp::audit_extra::type.

Here is the call graph for this function:

to_json()

auto dpp::json_interface< audit_entry >::to_json ( bool  with_id = false ) const

inlineinherited

Convert object to nlohmann::json.

Parameters

with_id

Whether to include the ID or not

Note

Some fields are conditionally filled, do not rely on all fields being present

Returns

json Json built from the structure

Friends And Related Function Documentation

json_interface< audit_entry >

friend struct json_interface< audit_entry >

friend

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.

Referenced by fill_from_json_impl().

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

---

The documentation for this struct was generated from the following files:

• auditlog.h
• auditlog.cpp