dpp::stage_instance Struct Reference

A stage instance. More...

#include "stage_instance.h"

Inheritance diagram for dpp::stage_instance:

Collaboration diagram for dpp::stage_instance:

Public Member Functions
	stage_instance ()
	Create a stage_instance object. More...
	~stage_instance ()=default
	Destroy the stage_instance object. More...
std::string	build_json (bool with_id=false) const
	Convert object to json string. More...
stage_instance &	fill_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...
auto	to_json (bool with_id=false) const
	Convert object to nlohmann::json. More...

Public Attributes
snowflake	channel_id
	The ID of the associated Stage channel. More...
bool	discoverable_disabled
	Whether or not Stage Discovery is disabled. More...
snowflake	guild_id
	The guild ID of the associated Stage channel. More...
snowflake	id = {}
	Unique ID of object set by Discord. More...
stage_privacy_level	privacy_level
	The privacy level of the Stage instance. More...
std::string	topic
	The topic of the Stage instance (1-120 characters). 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 >

Detailed Description

A stage instance.

Stage instances are like a conference facility, with moderators/speakers and listeners.

Constructor & Destructor Documentation

stage_instance()

dpp::stage_instance::stage_instance

(

)

Create a stage_instance object.

References channel_id, privacy_level, and topic.

~stage_instance()

dpp::stage_instance::~stage_instance ( )

default

Destroy the stage_instance object.

Member Function Documentation

build_json()

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

inlineinherited

Convert object to json string.

Parameters

with_id

Whether 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()

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

inlineinherited

Convert object from nlohmann::json.

Parameters

j	nlohmann::json object

Returns

T& Reference to self for fluent calling

fill_from_json_impl()

stage_instance & dpp::stage_instance::fill_from_json_impl ( const nlohmann::json *  j )

protected

Serialise a stage_instance object rom json.

Returns

stage_instance& 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

other

Other 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

other

Other object to compare against

Returns

true objects are the same id

false objects are not the same id

to_json()

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

inlineinherited

Convert object to nlohmann::json.

Parameters

with_id

Whether 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::stage_instance::to_json_impl ( bool  with_id = false ) const

protectedvirtual

Build json for this object.

Parameters

with_id

include ID

Returns

json Json of this object

Friends And Related Function Documentation

json_interface< stage_instance >

friend struct json_interface< stage_instance >

friend

Member Data Documentation

channel_id

snowflake dpp::stage_instance::channel_id

The ID of the associated Stage channel.

Referenced by stage_instance().

discoverable_disabled

bool dpp::stage_instance::discoverable_disabled

Whether or not Stage Discovery is disabled.

guild_id

snowflake dpp::stage_instance::guild_id

The guild ID of the associated Stage channel.

id

snowflake dpp::managed::id = {}

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.

Referenced by dpp::poll::add_answer(), dpp::cluster::create_webhook(), dpp::cluster::current_user_join_thread(), dpp::invite::fill_from_json_impl(), dpp::command_permission::fill_from_json_impl(), dpp::interaction::get_resolved_role(), dpp::interaction::get_resolved_user(), dpp::cluster::global_bulk_command_create(), dpp::cluster::global_bulk_command_delete(), dpp::cluster::global_command_delete(), dpp::cluster::global_command_edit(), dpp::cluster::guild_ban_delete(), dpp::cluster::guild_command_create(), dpp::cluster::guild_command_edit_permissions(), dpp::cluster::guild_get_integrations(), dpp::events::guild_member_update::handle(), dpp::events::guild_role_create::handle(), dpp::events::channel_create::handle(), dpp::events::voice_state_update::handle(), dpp::discord_voice_client::handle_frame(), main(), dpp::component::set_disabled(), and dpp::select_option::set_label().

privacy_level

stage_privacy_level dpp::stage_instance::privacy_level

The privacy level of the Stage instance.

Referenced by stage_instance().

topic

std::string dpp::stage_instance::topic

The topic of the Stage instance (1-120 characters).

Referenced by stage_instance().

---

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

• stage_instance.h
• stage_instance.cpp