dpp::welcome_channel Struct Reference

Defines a channel on a server's welcome screen. More...

#include "guild.h"

Inheritance diagram for dpp::welcome_channel:

Collaboration diagram for dpp::welcome_channel:

Public Member Functions
	welcome_channel ()
	Construct a new welcome channel object. More...
virtual	~welcome_channel ()=default
	Destroy the welcome channel object. More...
template<typename U = T, typename = decltype(std::declval<U&>().to_json_impl(bool{}))>
std::string	build_json (bool with_id=false) const
	Convert object to json string. More...
template<typename U = T, typename = decltype(std::declval<U&>().fill_from_json_impl(std::declval<nlohmann::json*>()))>
T &	fill_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. More...
welcome_channel &	set_channel_id (const snowflake _channel_id)
	Set the channel ID of this welcome channel object. More...
welcome_channel &	set_description (const std::string &_description)
	Set the description of this welcome channel object. More...
template<typename U = T, typename = decltype(std::declval<U&>().to_json_impl(bool{}))>
auto	to_json (bool with_id=false) const
	Convert object to nlohmann::json. More...

Public Attributes
snowflake	channel_id
	The channel's id. More...
std::string	description
	The description shown for the channel. More...
snowflake	emoji_id
	The emoji id, if the emoji is custom. More...
std::string	emoji_name
	The emoji name. More...

Protected Member Functions
welcome_channel &	fill_from_json_impl (nlohmann::json *j)
	Read class values from json object. More...
json	to_json_impl (bool with_id=false) const
	Build the json for this object. More...

Friends
struct	json_interface< welcome_channel >

Detailed Description

Defines a channel on a server's welcome screen.

Constructor & Destructor Documentation

welcome_channel()

dpp::welcome_channel::welcome_channel

(

)

Construct a new welcome channel object.

~welcome_channel()

virtual dpp::welcome_channel::~welcome_channel ( )

virtualdefault

Destroy the welcome channel object.

Member Function Documentation

build_json()

template<typename T >

template<typename U = T, typename = decltype(std::declval<U&>().to_json_impl(bool{}))>

std::string dpp::json_interface< T >::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

Referenced by dpp::cluster::create_webhook(), dpp::cluster::guild_ban_add(), dpp::cluster::guild_ban_delete(), dpp::cluster::guild_command_edit_permissions(), dpp::cluster::guild_create(), dpp::cluster::guild_get_integrations(), dpp::cluster::guild_get_preview(), dpp::cluster::guild_get_vanity(), and dpp::cluster::roles_get().

Here is the caller graph for this function:

fill_from_json()

template<typename T >

template<typename U = T, typename = decltype(std::declval<U&>().fill_from_json_impl(std::declval<nlohmann::json*>()))>

T& dpp::json_interface< T >::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

Referenced by dpp::invite::fill_from_json_impl(), dpp::thread::fill_from_json_impl(), dpp::scheduled_event::fill_from_json_impl(), dpp::from_json(), dpp::message::get_url(), and dpp::interaction_response::interaction_response().

Here is the caller graph for this function:

fill_from_json_impl()

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

protected

Read class values from json object.

Parameters

j	A json object to read from

Returns

A reference to self

set_channel_id()

welcome_channel & dpp::welcome_channel::set_channel_id

(

const snowflake

_channel_id

)

Set the channel ID of this welcome channel object.

Parameters

_channel_id

The channel ID to set

Returns

Reference to self, so these method calls may be chained

References dpp::welcome_screen::description.

set_description()

welcome_channel & dpp::welcome_channel::set_description

(

const std::string &

_description

)

Set the description of this welcome channel object.

Parameters

_description

The description to set

Returns

Reference to self, so these method calls may be chained

to_json()

template<typename T >

template<typename U = T, typename = decltype(std::declval<U&>().to_json_impl(bool{}))>

auto dpp::json_interface< T >::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

Referenced by dpp::cluster::delete_webhook_with_token(), and dpp::onboarding_prompt::onboarding_prompt().

Here is the caller graph for this function:

to_json_impl()

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

protected

Build the json for this object.

Parameters

with_id

include the id in the JSON

Returns

json JSON data

Friends And Related Function Documentation

json_interface< welcome_channel >

friend struct json_interface< welcome_channel >

friend

Member Data Documentation

channel_id

snowflake dpp::welcome_channel::channel_id

The channel's id.

Referenced by dpp::guild_member::has_started_onboarding().

description

std::string dpp::welcome_channel::description

The description shown for the channel.

emoji_id

snowflake dpp::welcome_channel::emoji_id

The emoji id, if the emoji is custom.

Referenced by dpp::guild_member::has_bypasses_verification().

emoji_name

std::string dpp::welcome_channel::emoji_name

The emoji name.

Note

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

---

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

• guild.h
• guild.cpp