dpp::json_interface< T > Struct Template Reference

Represents an interface for an object that can optionally implement functions for converting to and from nlohmann::json. In the event either parse_from_json() or build_json() are not implemented and are called, they will throw at runtime. More...

#include <json_interface.h>

Inheritance diagram for dpp::json_interface< T >:

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

Protected Member Functions
	~json_interface ()=default

Detailed Description

template<typename T>
struct dpp::json_interface< T >

Represents an interface for an object that can optionally implement functions for converting to and from nlohmann::json. In the event either parse_from_json() or build_json() are not implemented and are called, they will throw at runtime.

Template Parameters

T	Type of class that implements the interface

Constructor & Destructor Documentation

~json_interface()

template<typename T >

dpp::json_interface< T >::~json_interface ( )

protecteddefault

Member Function Documentation

build_json()

template<typename T >

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

inlinevirtual

Build JSON string from the object.

Parameters

with_id

Include the ID in the JSON

Returns

std::string JSON string version of object

Reimplemented in dpp::interaction_response, dpp::interaction_modal_response, dpp::interaction, dpp::slashcommand, dpp::ban, dpp::channel, dpp::thread, dpp::dtemplate, dpp::emoji, dpp::guild, dpp::integration, dpp::invite, dpp::presence, dpp::role, dpp::scheduled_event, dpp::stage_instance, dpp::voiceregion, dpp::voicestate, dpp::webhook, dpp::sticker, dpp::sticker_pack, dpp::user, dpp::user_identified, and dpp::prune.

fill_from_json()

template<typename T >

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

inline

Convert object from nlohmann::json.

Parameters

j	nlohmann::json object

Returns

T& Reference to self for fluent calling