dpp::welcome_channel
dpp::json_interface< welcome_channel >
guild.h
struct friend struct json_interface< welcome_channel > json_interface< welcome_channel > dpp::welcome_channel::json_interface< welcome_channel > json_interface< welcome_channel >
snowflake snowflake dpp::welcome_channel::channel_id channel_id dpp::welcome_channel::channel_id

The channel's id.

std::string std::string dpp::welcome_channel::description description dpp::welcome_channel::description

The description shown for the channel.

snowflake snowflake dpp::welcome_channel::emoji_id emoji_id dpp::welcome_channel::emoji_id

The emoji id, if the emoji is custom.

std::string std::string dpp::welcome_channel::emoji_name emoji_name dpp::welcome_channel::emoji_name

The emoji name.

name if custom, the unicode character if standard, or null if no emoji is set.

welcome_channel & welcome_channel & dpp::welcome_channel::fill_from_json_impl (nlohmann::json *j) fill_from_json_impl dpp::welcome_channel::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_channel::to_json_impl (bool with_id=false) const to_json_impl dpp::welcome_channel::to_json_impl bool with_id false

Build the json for this object.

with_id

include the id in the JSON

json JSON data

dpp::welcome_channel::welcome_channel
()
welcome_channel
dpp::welcome_channel::welcome_channel

Construct a new welcome channel object.

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

Destroy the welcome channel object.

std::string std::string dpp::json_interface< welcome_channel >::build_json (bool with_id=false) const build_json dpp::json_interface< welcome_channel >::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_channel & welcome_channel & dpp::json_interface< welcome_channel >::fill_from_json (nlohmann::json *j) fill_from_json dpp::json_interface< welcome_channel >::fill_from_json nlohmann::json * j

Convert object from nlohmann::json.

j

nlohmann::json object

T& Reference to self for fluent calling

welcome_channel & welcome_channel & dpp::welcome_channel::set_channel_id (const snowflake _channel_id) set_channel_id dpp::welcome_channel::set_channel_id const snowflake _channel_id

Set the channel ID of this welcome channel object.

_channel_id

The channel ID to set

Reference to self, so these method calls may be chained

welcome_channel & welcome_channel & dpp::welcome_channel::set_description (const std::string &_description) set_description dpp::welcome_channel::set_description const std::string & _description

Set the description of this welcome channel object.

_description

The description to set

Reference to self, so these method calls may be chained

auto auto dpp::json_interface< welcome_channel >::to_json (bool with_id=false) const to_json dpp::json_interface< welcome_channel >::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 channel on a server's welcome screen.

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