![]() |
D++ (DPP)
C++ Discord API Bot Library
|
Represents a guild's onboarding flow. More...
#include <guild.h>
Public Member Functions | |
onboarding () | |
Construct a new onboarding object. More... | |
virtual | ~onboarding ()=default |
Destroy the onboarding object. More... | |
onboarding & | set_guild_id (const snowflake id) |
Set guild_id of this onboarding object. More... | |
onboarding & | set_mode (const onboarding_mode m) |
Set the mode of this onboarding object. More... | |
onboarding & | set_enabled (const bool is_enabled) |
Set the enabling of this onboarding object. More... | |
onboarding & | 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... | |
std::string | build_json (bool with_id=false) const |
Convert object to json string. More... | |
Public Attributes | |
snowflake | guild_id |
ID of the guild this onboarding is part of. More... | |
std::vector< onboarding_prompt > | prompts |
Prompts shown during onboarding and in customize community. More... | |
std::vector< snowflake > | default_channel_ids |
Channel IDs that members get opted into automatically. More... | |
onboarding_mode | mode |
Current mode of onboarding (defaults to dpp::gom_default) More... | |
bool | enabled |
Whether onboarding is enabled in the guild. More... | |
Protected Member Functions | |
onboarding & | 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< onboarding > |
Represents a guild's onboarding flow.
dpp::onboarding::onboarding | ( | ) |
Construct a new onboarding object.
|
virtualdefault |
Destroy the onboarding object.
|
inlineinherited |
Convert object to json string.
with_id | Whether to include the ID or not |
|
inlineinherited |
Convert object from nlohmann::json.
j | nlohmann::json object |
|
protected |
Read class values from json object.
j | A json object to read from |
onboarding & dpp::onboarding::set_enabled | ( | const bool | is_enabled | ) |
Set the enabling of this onboarding object.
is_enabled | bool Whether onboarding is enabled in the guild |
onboarding & dpp::onboarding::set_guild_id | ( | const snowflake | id | ) |
Set guild_id of this onboarding object.
guild_id | Guild ID to set |
onboarding & dpp::onboarding::set_mode | ( | const onboarding_mode | m | ) |
Set the mode of this onboarding object.
m | onboarding_mode Mode to set |
|
inlineinherited |
Convert object to nlohmann::json.
with_id | Whether to include the ID or not |
|
protected |
Build the json for this object.
with_id | include the id in the JSON |
|
friend |
std::vector<snowflake> dpp::onboarding::default_channel_ids |
Channel IDs that members get opted into automatically.
bool dpp::onboarding::enabled |
Whether onboarding is enabled in the guild.
snowflake dpp::onboarding::guild_id |
ID of the guild this onboarding is part of.
onboarding_mode dpp::onboarding::mode |
Current mode of onboarding (defaults to dpp::gom_default)
std::vector<onboarding_prompt> dpp::onboarding::prompts |
Prompts shown during onboarding and in customize community.