D++ (DPP)  10.0.30
C++ Discord API Bot Library
dpp::onboarding_prompt_option Struct Reference

Represents an onboarding prompt option. More...

#include "guild.h"

Inheritance diagram for dpp::onboarding_prompt_option:
Collaboration diagram for dpp::onboarding_prompt_option:

Public Member Functions

 onboarding_prompt_option ()
 Construct a new onboarding prompt option object. More...
 
virtual ~onboarding_prompt_option ()=default
 Destroy the onboarding prompt option object. More...
 
std::string build_json (bool with_id=false) const
 Convert object to json string. More...
 
onboarding_prompt_optionfill_from_json (nlohmann::json *j)
 Convert object from nlohmann::json. More...
 
constexpr double get_creation_time () const noexcept
 Get the creation time of this object according to Discord. More...
 
constexpr bool operator!= (const managed &other) const noexcept
 Comparison operator for comparing two managed objects by id. More...
 
constexpr bool operator== (const managed &other) const noexcept
 Comparison operator for comparing two managed objects by id. More...
 
onboarding_prompt_optionset_description (const std::string &_description)
 Set the description of this onboarding prompt option object. More...
 
onboarding_prompt_optionset_emoji (const dpp::emoji &_emoji)
 Set the emoji of this onboarding prompt option object. More...
 
onboarding_prompt_optionset_title (const std::string &_title)
 Set the title of this onboarding prompt option object. More...
 
auto to_json (bool with_id=false) const
 Convert object to nlohmann::json. More...
 

Public Attributes

std::vector< snowflakechannel_ids
 IDs for channels a member is added to when the option is selected. More...
 
std::string description
 Description of the option. More...
 
dpp::emoji emoji
 Emoji of the option. More...
 
snowflake id = {}
 Unique ID of object set by Discord. More...
 
std::vector< snowflakerole_ids
 IDs for roles assigned to a member when the option is selected. More...
 
std::string title
 Title of the option. More...
 

Protected Member Functions

onboarding_prompt_optionfill_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_prompt_option >
 

Detailed Description

Represents an onboarding prompt option.

Constructor & Destructor Documentation

◆ onboarding_prompt_option()

dpp::onboarding_prompt_option::onboarding_prompt_option ( )

Construct a new onboarding prompt option object.

◆ ~onboarding_prompt_option()

virtual dpp::onboarding_prompt_option::~onboarding_prompt_option ( )
virtualdefault

Destroy the onboarding prompt option object.

Member Function Documentation

◆ build_json()

std::string dpp::json_interface< onboarding_prompt_option >::build_json ( bool  with_id = false) const
inlineinherited

Convert object to json string.

Parameters
with_idWhether 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

◆ fill_from_json()

Convert object from nlohmann::json.

Parameters
jnlohmann::json object
Returns
T& Reference to self for fluent calling

◆ fill_from_json_impl()

onboarding_prompt_option & dpp::onboarding_prompt_option::fill_from_json_impl ( nlohmann::json j)
protected

Read class values from json object.

Parameters
jA json object to read from
Returns
A reference to self

◆ get_creation_time()

constexpr double dpp::managed::get_creation_time ( ) const
inlineconstexprnoexceptinherited

Get the creation time of this object according to Discord.

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

◆ operator!=()

constexpr bool dpp::managed::operator!= ( const managed other) const
inlineconstexprnoexceptinherited

Comparison operator for comparing two managed objects by id.

Parameters
otherOther object to compare against
Returns
true objects are not the same id
false objects are the same id

◆ operator==()

constexpr bool dpp::managed::operator== ( const managed other) const
inlineconstexprnoexceptinherited

Comparison operator for comparing two managed objects by id.

Parameters
otherOther object to compare against
Returns
true objects are the same id
false objects are not the same id

◆ set_description()

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

Set the description of this onboarding prompt option object.

Parameters
_descriptionThe description to set
Returns
Reference to self, so these method calls may be chained

◆ set_emoji()

onboarding_prompt_option & dpp::onboarding_prompt_option::set_emoji ( const dpp::emoji _emoji)

Set the emoji of this onboarding prompt option object.

Parameters
_emojiThe emoji to set
Returns
Reference to self, so these method calls may be chained

◆ set_title()

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

Set the title of this onboarding prompt option object.

Parameters
_titleThe title to set
Returns
Reference to self, so these method calls may be chained

◆ to_json()

auto dpp::json_interface< onboarding_prompt_option >::to_json ( bool  with_id = false) const
inlineinherited

Convert object to nlohmann::json.

Parameters
with_idWhether 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

◆ to_json_impl()

json dpp::onboarding_prompt_option::to_json_impl ( bool  with_id = false) const
protected

Build the json for this object.

Parameters
with_idinclude the id in the JSON
Returns
json data

Friends And Related Function Documentation

◆ json_interface< onboarding_prompt_option >

friend struct json_interface< onboarding_prompt_option >
friend

Member Data Documentation

◆ channel_ids

std::vector<snowflake> dpp::onboarding_prompt_option::channel_ids

IDs for channels a member is added to when the option is selected.

◆ description

std::string dpp::onboarding_prompt_option::description

Description of the option.

◆ emoji

dpp::emoji dpp::onboarding_prompt_option::emoji

Emoji of the option.

◆ id

◆ role_ids

std::vector<snowflake> dpp::onboarding_prompt_option::role_ids

IDs for roles assigned to a member when the option is selected.

◆ title

std::string dpp::onboarding_prompt_option::title

Title of the option.


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