dpp::guild_widget Class Reference

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

#include "guild.h"

Inheritance diagram for dpp::guild_widget:

Collaboration diagram for dpp::guild_widget:

Public Member Functions
	guild_widget ()
	Construct a new guild widget object. More...
std::string	build_json (bool with_id=false) const
	Convert object to json string. More...
guild_widget &	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
snowflake	channel_id
	Channel widget points to. More...
bool	enabled
	True if enabled. More...

Protected Member Functions
guild_widget &	fill_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_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()

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

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

protected

Build a guild widget from json.

Parameters

j	json 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_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

to_json_impl()

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

protected

Build json for a guild widget.

Parameters

with_id

Add ID to output

Returns

std::string guild widget stringified json

References dpp::find_role(), dpp::guild_member::get_roles(), dpp::guild::owner_id, dpp::role::permissions, and dpp::guild_member::user_id.

Here is the call graph for this function:

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.

---

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

• guild.h
• guild.cpp