D++ (DPP)
C++ Discord API Bot Library
dpp::guild_widget Class Reference

Represents a guild widget, simple web widget of member list. More...

+ Inheritance diagram for dpp::guild_widget:
+ Collaboration diagram for dpp::guild_widget:

Public Member Functions

 guild_widget ()
 Construct a new guild widget object. More...
 
guild_widgetfill_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...
 
std::string build_json (bool with_id=false) const
 Convert object to json string. More...
 

Public Attributes

snowflake channel_id
 Channel widget points to. More...
 
bool enabled
 True if enabled. More...
 

Protected Member Functions

guild_widgetfill_from_json_impl (nlohmann::json *j)
 Build a guild widget from json. More...
 
json to_json_impl (bool with_id=false) const
 Build json for a guild widget. More...
 

Friends

struct json_interface< guild_widget >
 

Detailed Description

Represents a guild widget, simple web widget of member list.

Constructor & Destructor Documentation

◆ guild_widget()

dpp::guild_widget::guild_widget ( )

Construct a new guild widget object.

Member Function Documentation

◆ build_json()

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

Convert object to json string.

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

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

Convert object from nlohmann::json.

Parameters
jnlohmann::json object
Returns
T& Reference to self for fluent calling

◆ fill_from_json_impl()

guild_widget& dpp::guild_widget::fill_from_json_impl ( nlohmann::json *  j)
protected

Build a guild widget from json.

Parameters
jjson to build from
Returns
guild_widget& reference to self

◆ to_json()

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

Convert object to nlohmann::json.

Parameters
with_idWhether 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

◆ to_json_impl()

json dpp::guild_widget::to_json_impl ( bool  with_id = false) const
protected

Build json for a guild widget.

Parameters
with_idAdd ID to output
Returns
std::string guild widget stringified json

Friends And Related Function Documentation

◆ json_interface< guild_widget >

friend struct json_interface< guild_widget >
friend

Member Data Documentation

◆ channel_id

snowflake dpp::guild_widget::channel_id

Channel widget points to.

◆ enabled

bool dpp::guild_widget::enabled

True if enabled.

D++ Library version 9.0.13D++ Library version 9.0.12D++ Library version 9.0.11D++ Library version 9.0.10D++ Library version 9.0.9D++ Library version 9.0.8D++ Library version 9.0.7D++ Library version 9.0.6D++ Library version 9.0.5D++ Library version 9.0.4D++ Library version 9.0.3D++ Library version 9.0.2D++ Library version 9.0.1D++ Library version 9.0.0D++ Library version 1.0.2D++ Library version 1.0.1D++ Library version 1.0.0