dpp::welcome_screen
dpp::json_interface< welcome_screen >
guild.h
struct friend struct json_interface< welcome_screen > json_interface< welcome_screen > dpp::welcome_screen::json_interface< welcome_screen > json_interface< welcome_screen >
std::string std::string dpp::welcome_screen::description description dpp::welcome_screen::description

The server description shown in the welcome screen.

std::vector< welcome_channel > std::vector<welcome_channel> dpp::welcome_screen::welcome_channels welcome_channels dpp::welcome_screen::welcome_channels

The channels shown in the welcome screen (max 5).

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

Read class values from json object.

j

A json object to read from

A reference to self

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

Build the json for this object.

with_id

include the id in the JSON

std::string json data

dpp::welcome_screen::welcome_screen
()=default
welcome_screen
dpp::welcome_screen::welcome_screen

Construct a new welcome screen object.

virtual dpp::welcome_screen::~welcome_screen
()=default
~welcome_screen
dpp::welcome_screen::~welcome_screen

Destroy the welcome screen object.

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

Convert object to json string.

with_id

Whether to include the ID or not

Some fields are conditionally filled, do not rely on all fields being present

std::string Json built from the structure

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

Convert object from nlohmann::json.

j

nlohmann::json object

T& Reference to self for fluent calling

welcome_screen & welcome_screen & dpp::welcome_screen::set_description (const std::string &s) set_description dpp::welcome_screen::set_description const std::string & s

Set the server description for this welcome screen object shown in the welcome screen.

s

string The server description

Reference to self, so these method calls may be chained

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

Convert object to nlohmann::json.

with_id

Whether to include the ID or not

Some fields are conditionally filled, do not rely on all fields being present

json Json built from the structure

Defines a server's welcome screen.

dpp::json_interface< T >
dpp::json_interface< welcome_screen >
< welcome_screen >
dpp::welcome_screen
T
dpp::json_interface< T >
dpp::json_interface< welcome_channel >
< welcome_channel >
dpp::json_interface< welcome_screen >
< welcome_screen >
dpp::snowflake
value
dpp::welcome_channel
description
emoji_name
channel_id
emoji_id
dpp::welcome_screen
description
welcome_channels
std::basic_string< Char >
std::string
std::vector< T >
elements
std::vector< dpp::welcome_channel >
elements
< dpp::welcome_channel >
uint64_t
- dpp::welcome_screen
  build_json
- dpp::welcome_screen
  description
- dpp::welcome_screen
  fill_from_json
- dpp::welcome_screen
  fill_from_json_impl
- dpp::welcome_screen
  json_interface< welcome_screen >
- dpp::welcome_screen
  set_description
- dpp::welcome_screen
  to_json
- dpp::welcome_screen
  to_json_impl
- dpp::welcome_screen
  welcome_channels
- dpp::welcome_screen
  welcome_screen
- dpp::welcome_screen
  ~welcome_screen