dpp::onboarding
dpp::json_interface< onboarding >
guild.h
struct friend struct json_interface< onboarding > json_interface< onboarding > dpp::onboarding::json_interface< onboarding > json_interface< onboarding >
std::vector< snowflake > std::vector<snowflake> dpp::onboarding::default_channel_ids default_channel_ids dpp::onboarding::default_channel_ids

Channel IDs that members get opted into automatically.

bool bool dpp::onboarding::enabled enabled dpp::onboarding::enabled

Whether onboarding is enabled in the guild.

snowflake snowflake dpp::onboarding::guild_id guild_id dpp::onboarding::guild_id

ID of the guild this onboarding is part of.

onboarding_mode onboarding_mode dpp::onboarding::mode mode dpp::onboarding::mode

Current mode of onboarding (defaults to dpp::gom_default).

std::vector< onboarding_prompt > std::vector<onboarding_prompt> dpp::onboarding::prompts prompts dpp::onboarding::prompts

Prompts shown during onboarding and in customize community.

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

Build the json for this object.

with_id

include the id in the JSON

json data

dpp::onboarding::onboarding
()
onboarding
dpp::onboarding::onboarding

Construct a new onboarding object.

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

Destroy the onboarding object.

std::string std::string dpp::json_interface< onboarding >::build_json (bool with_id=false) const build_json dpp::json_interface< onboarding >::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

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

Convert object from nlohmann::json.

j

nlohmann::json object

T& Reference to self for fluent calling

onboarding & onboarding & dpp::onboarding::set_enabled (const bool is_enabled) set_enabled 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

Reference to self, so these method calls may be chained

onboarding & onboarding & dpp::onboarding::set_guild_id (const snowflake id) set_guild_id dpp::onboarding::set_guild_id const snowflake id

Set guild_id of this onboarding object.

id

Guild ID to set

Reference to self, so these method calls may be chained

onboarding & onboarding & dpp::onboarding::set_mode (const onboarding_mode m) set_mode dpp::onboarding::set_mode const onboarding_mode m

Set the mode of this onboarding object.

m

onboarding_mode Mode to set

Reference to self, so these method calls may be chained

auto auto dpp::json_interface< onboarding >::to_json (bool with_id=false) const to_json dpp::json_interface< onboarding >::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

Represents a guild's onboarding flow.

dpp::json_interface< T >
dpp::json_interface< onboarding >
< onboarding >
dpp::onboarding
T
bool
dpp::emoji
name
roles
user_id
image_data
flags
dpp::json_interface< T >
dpp::json_interface< emoji >
< emoji >
dpp::json_interface< onboarding >
< onboarding >
dpp::json_interface< onboarding_prompt >
< onboarding_prompt >
dpp::json_interface< onboarding_prompt_option >
< onboarding_prompt_option >
dpp::managed
id
dpp::onboarding
guild_id
prompts
default_channel_ids
mode
enabled
dpp::onboarding_prompt
type
options
title
flags
dpp::onboarding_prompt_option
channel_ids
role_ids
emoji
description
title
dpp::snowflake
value
dpp::utility::image_data
data
size
type
image_type
onboarding_mode
onboarding_prompt_type
std::basic_string< Char >
byte
std::string
std::unique_ptr< T >
ptr
std::unique_ptr< std::byte[]>
ptr
< std::byte[]>
std::vector< T >
elements
std::vector< dpp::onboarding_prompt >
elements
< dpp::onboarding_prompt >
std::vector< dpp::onboarding_prompt_option >
elements
< dpp::onboarding_prompt_option >
std::vector< dpp::snowflake >
elements
< dpp::snowflake >
uint32_t
uint64_t
uint8_t
- dpp::onboarding
  build_json
- dpp::onboarding
  default_channel_ids
- dpp::onboarding
  enabled
- dpp::onboarding
  fill_from_json
- dpp::onboarding
  fill_from_json_impl
- dpp::onboarding
  guild_id
- dpp::onboarding
  json_interface< onboarding >
- dpp::onboarding
  mode
- dpp::onboarding
  onboarding
- dpp::onboarding
  prompts
- dpp::onboarding
  set_enabled
- dpp::onboarding
  set_guild_id
- dpp::onboarding
  set_mode
- dpp::onboarding
  to_json
- dpp::onboarding
  to_json_impl
- dpp::onboarding
  ~onboarding