dpp::ban Class Reference

The ban class represents a ban on a guild. More...

#include <ban.h>

Inheritance diagram for dpp::ban:

Collaboration diagram for dpp::ban:

Public Member Functions
	ban ()
	~ban ()
ban &	fill_from_json (nlohmann::json *j)
std::string	build_json (bool with_id=false) const
	Build json representation of a ban. More...
ban &	parse_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. More...

Public Attributes
std::string	reason
snowflake	user_id

Detailed Description

The ban class represents a ban on a guild.

Constructor & Destructor Documentation

ban()

dpp::ban::ban

(

)

Constructor

~ban()

dpp::ban::~ban

(

)

Destructor

Member Function Documentation

build_json()

std::string dpp::ban::build_json ( bool  with_id = false ) const

virtual

Build json representation of a ban.

Parameters

with_id

Include ID in json

Returns

std::string stringified json

Reimplemented from dpp::json_interface< ban >.

fill_from_json()

ban & dpp::ban::fill_from_json

(

nlohmann::json *

j

)

Read class values from json object

Parameters

j	A json object to read from

Returns

A reference to self

parse_from_json()

ban & dpp::json_interface< ban >::parse_from_json ( nlohmann::json *  j )

inlineinherited

Convert object from nlohmann::json.

Parameters

j	nlohmann::json object

Returns

T& Reference to self for fluent calling

Member Data Documentation

reason

std::string dpp::ban::reason

The ban reason

user_id

snowflake dpp::ban::user_id

User ID the ban applies to