dpp::auditlog Class Reference

The auditlog class represents the audit log entries of a guild. More...

#include "auditlog.h"

Inheritance diagram for dpp::auditlog:

Collaboration diagram for dpp::auditlog:

Public Member Functions
	auditlog ()=default
	Constructor. More...
virtual	~auditlog ()=default
	Destructor. More...
std::string	build_json (bool with_id=false) const
	Convert object to json string. More...
auditlog &	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_entry >	entries
	Audit log entries. More...

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

Friends
struct	json_interface< auditlog >

Detailed Description

The auditlog class represents the audit log entries of a guild.

Constructor & Destructor Documentation

auditlog()

dpp::auditlog::auditlog ( )

default

Constructor.

~auditlog()

virtual dpp::auditlog::~auditlog ( )

virtualdefault

Destructor.

Member Function Documentation

build_json()

std::string dpp::json_interface< auditlog >::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()

auditlog & dpp::json_interface< auditlog >::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()

auditlog & dpp::auditlog::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

to_json()

auto dpp::json_interface< auditlog >::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< auditlog >

friend struct json_interface< auditlog >

friend

Member Data Documentation

entries

std::vector<audit_entry> dpp::auditlog::entries

Audit log entries.

---

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

• auditlog.h
• auditlog.cpp