![]() |
D++ (DPP)
C++ Discord API Bot Library
|
A stage instance. Stage instances are like a conference facility, with moderators/speakers and listeners. More...
#include <stage_instance.h>
Public Member Functions | |
stage_instance () | |
Create a stage_instance object. More... | |
~stage_instance ()=default | |
Destroy the stage_instance object. 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... | |
stage_instance & | 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 |
The guild id of the associated Stage channel. More... | |
snowflake | channel_id |
The id of the associated Stage channel. More... | |
std::string | topic |
The topic of the Stage instance (1-120 characters) More... | |
stage_privacy_level | privacy_level |
The privacy level of the Stage instance. More... | |
bool | discoverable_disabled |
Whether or not Stage Discovery is disabled. More... | |
snowflake | 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. More... | |
Protected Member Functions | |
stage_instance & | fill_from_json_impl (const nlohmann::json *j) |
Serialise a stage_instance object rom json. More... | |
virtual json | to_json_impl (bool with_id=false) const |
Build json for this object. More... | |
Friends | |
struct | json_interface< stage_instance > |
A stage instance. Stage instances are like a conference facility, with moderators/speakers and listeners.
dpp::stage_instance::stage_instance | ( | ) |
Create a stage_instance object.
|
default |
Destroy the stage_instance 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 |
Serialise a stage_instance object rom json.
|
inlineconstexprnoexceptinherited |
Get the creation time of this object according to Discord.
|
inlineconstexprnoexceptinherited |
Comparison operator for comparing two managed objects by id.
other | Other object to compare against |
|
inlineconstexprnoexceptinherited |
Comparison operator for comparing two managed objects by id.
other | Other object to compare against |
|
inlineinherited |
Convert object to nlohmann::json.
with_id | Whether to include the ID or not |
|
protectedvirtual |
Build json for this object.
with_id | include ID |
|
friend |
snowflake dpp::stage_instance::channel_id |
The id of the associated Stage channel.
bool dpp::stage_instance::discoverable_disabled |
Whether or not Stage Discovery is disabled.
snowflake dpp::stage_instance::guild_id |
The guild id of the associated Stage channel.
|
inherited |
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.
stage_privacy_level dpp::stage_instance::privacy_level |
The privacy level of the Stage instance.
std::string dpp::stage_instance::topic |
The topic of the Stage instance (1-120 characters)