dpp::onboarding_prompt
dpp::managed
dpp::json_interface< onboarding_prompt >
guild.h
struct friend struct json_interface< onboarding_prompt > json_interface< onboarding_prompt > dpp::onboarding_prompt::json_interface< onboarding_prompt > json_interface< onboarding_prompt >
uint8_t uint8_t dpp::onboarding_prompt::flags flags dpp::onboarding_prompt::flags

A set of flags built from the bitmask defined by dpp::onboarding_prompt_flags.

snowflake snowflake dpp::managed::id id dpp::managed::id = {}

Unique ID of object set by Discord. This value contains a timestamp, worker ID, internal server ID, and an incrementing value. Only the timestamp is relevant to us as useful metadata.

std::vector< onboarding_prompt_option > std::vector<onboarding_prompt_option> dpp::onboarding_prompt::options options dpp::onboarding_prompt::options

Options available within the prompt.

std::string std::string dpp::onboarding_prompt::title title dpp::onboarding_prompt::title

Title of the prompt.

onboarding_prompt_type onboarding_prompt_type dpp::onboarding_prompt::type type dpp::onboarding_prompt::type

Type of prompt (defaults to dpp::opt_multiple_choice).

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

Construct a new onboarding prompt object.

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

Destroy the onboarding prompt object.

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

Convert object from nlohmann::json.

j

nlohmann::json object

T& Reference to self for fluent calling

double double dpp::managed::get_creation_time () const noexcept get_creation_time dpp::managed::get_creation_time

Get the creation time of this object according to Discord.

double creation time inferred from the snowflake ID. The minimum possible value is the first second of 2015.

bool bool dpp::onboarding_prompt::is_in_onboarding () const is_in_onboarding dpp::onboarding_prompt::is_in_onboarding

Indicates whether the prompt is present in the onboarding flow.

bool True if the prompt is present in the onboarding flow. False if the prompt will only appear in the Channels & Roles tab

bool bool dpp::onboarding_prompt::is_required () const is_required dpp::onboarding_prompt::is_required

Indicates whether the prompt is required before a user completes the onboarding flow.

bool True if the prompt is required before a user completes the onboarding flow

bool bool dpp::onboarding_prompt::is_single_select () const is_single_select dpp::onboarding_prompt::is_single_select

Indicates whether users are limited to selecting one option for the prompt.

bool True if the users are limited to selecting one option for the prompt

bool bool dpp::managed::operator!= (const managed &other) const noexcept operator!= dpp::managed::operator!= const managed & other

Comparison operator for comparing two managed objects by id.

other

Other object to compare against

true objects are not the same id

false objects are the same id

bool bool dpp::managed::operator== (const managed &other) const noexcept operator== dpp::managed::operator== const managed & other

Comparison operator for comparing two managed objects by id.

other

Other object to compare against

true objects are the same id

false objects are not the same id

onboarding_prompt & onboarding_prompt & dpp::onboarding_prompt::set_title (const std::string &_title) set_title dpp::onboarding_prompt::set_title const std::string & _title

Set the title of this onboarding prompt object.

_title

The title to set

Reference to self, so these method calls may be chained

onboarding_prompt & onboarding_prompt & dpp::onboarding_prompt::set_type (const onboarding_prompt_type _type) set_type dpp::onboarding_prompt::set_type const onboarding_prompt_type _type

Set the type of this onboarding prompt object.

_type

The prompt type to set

Reference to self, so these method calls may be chained

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

dpp::json_interface< T >
dpp::json_interface< onboarding_prompt >
< onboarding_prompt >
dpp::managed
dpp::onboarding_prompt
T
dpp::emoji
name
roles
user_id
image_data
flags
dpp::json_interface< T >
dpp::json_interface< emoji >
< emoji >
dpp::json_interface< onboarding_prompt >
< onboarding_prompt >
dpp::json_interface< onboarding_prompt_option >
< onboarding_prompt_option >
dpp::managed
id
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_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_option >
elements
< dpp::onboarding_prompt_option >
std::vector< dpp::snowflake >
elements
< dpp::snowflake >
uint32_t
uint64_t
uint8_t
- dpp::onboarding_prompt
  build_json
- dpp::onboarding_prompt
  fill_from_json
- dpp::onboarding_prompt
  fill_from_json_impl
- dpp::onboarding_prompt
  flags
- dpp::onboarding_prompt
  get_creation_time
- dpp::onboarding_prompt
  id
- dpp::onboarding_prompt
  is_in_onboarding
- dpp::onboarding_prompt
  is_required
- dpp::onboarding_prompt
  is_single_select
- dpp::onboarding_prompt
  json_interface< onboarding_prompt >
- dpp::onboarding_prompt
  managed
- dpp::onboarding_prompt
  managed
- dpp::onboarding_prompt
  managed
- dpp::onboarding_prompt
  managed
- dpp::onboarding_prompt
  onboarding_prompt
- dpp::onboarding_prompt
  operator!=
- dpp::onboarding_prompt
  operator=
- dpp::onboarding_prompt
  operator=
- dpp::onboarding_prompt
  operator==
- dpp::onboarding_prompt
  options
- dpp::onboarding_prompt
  set_title
- dpp::onboarding_prompt
  set_type
- dpp::onboarding_prompt
  title
- dpp::onboarding_prompt
  to_json
- dpp::onboarding_prompt
  to_json_impl
- dpp::onboarding_prompt
  type
- dpp::onboarding_prompt
  ~managed
- dpp::onboarding_prompt
  ~onboarding_prompt