D++ (DPP)
C++ Discord API Bot Library
dpp::voicestate Class Reference

Represents the voice state of a user on a guild These are stored in the dpp::guild object, and accessible there, or via dpp::channel::get_voice_members. More...

+ Inheritance diagram for dpp::voicestate:
+ Collaboration diagram for dpp::voicestate:

Public Member Functions

 voicestate ()
 Construct a new voicestate object. More...
 
virtual ~voicestate ()=default
 Destroy the voicestate object. More...
 
bool is_deaf () const
 Return true if the user is deafened by the server. More...
 
bool is_mute () const
 Return true if the user is muted by the server. More...
 
bool is_self_mute () const
 Return true if user muted themselves. More...
 
bool is_self_deaf () const
 Return true if user deafened themselves. More...
 
bool self_stream () const
 Return true if the user is streaming using "Go Live". More...
 
bool self_video () const
 Return true if the user's camera is enabled. More...
 
bool is_suppressed () const
 Return true if user is suppressed. More...
 
voicestatefill_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

class discord_clientshard
 Owning shard. More...
 
snowflake guild_id {0}
 Optional: The guild id this voice state is for. More...
 
snowflake channel_id {0}
 The channel id this user is connected to. More...
 
snowflake user_id {0}
 The user id this voice state is for. More...
 
std::string session_id
 The session id for this voice state. More...
 
uint8_t flags {0}
 Voice state flags from dpp::voicestate_flags. More...
 
time_t request_to_speak {0}
 The time at which the user requested to speak. More...
 

Protected Member Functions

voicestatefill_from_json_impl (nlohmann::json *j)
 Fill voicestate object from json data. More...
 

Friends

struct json_interface< voicestate >
 

Detailed Description

Represents the voice state of a user on a guild These are stored in the dpp::guild object, and accessible there, or via dpp::channel::get_voice_members.

Constructor & Destructor Documentation

◆ voicestate()

dpp::voicestate::voicestate ( )

Construct a new voicestate object.

◆ ~voicestate()

virtual dpp::voicestate::~voicestate ( )
virtualdefault

Destroy the voicestate object.

Member Function Documentation

◆ build_json()

std::string dpp::json_interface< voicestate >::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()

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

Convert object from nlohmann::json.

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

◆ fill_from_json_impl()

voicestate& dpp::voicestate::fill_from_json_impl ( nlohmann::json *  j)
protected

Fill voicestate object from json data.

Parameters
jJSON data to fill from
Returns
voicestate& Reference to self

◆ is_deaf()

bool dpp::voicestate::is_deaf ( ) const

Return true if the user is deafened by the server.

◆ is_mute()

bool dpp::voicestate::is_mute ( ) const

Return true if the user is muted by the server.

◆ is_self_deaf()

bool dpp::voicestate::is_self_deaf ( ) const

Return true if user deafened themselves.

◆ is_self_mute()

bool dpp::voicestate::is_self_mute ( ) const

Return true if user muted themselves.

◆ is_suppressed()

bool dpp::voicestate::is_suppressed ( ) const

Return true if user is suppressed.

"HELP HELP I'M BEING SUPPRESSED!"

◆ self_stream()

bool dpp::voicestate::self_stream ( ) const

Return true if the user is streaming using "Go Live".

◆ self_video()

bool dpp::voicestate::self_video ( ) const

Return true if the user's camera is enabled.

◆ to_json()

auto dpp::json_interface< voicestate >::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

Friends And Related Function Documentation

◆ json_interface< voicestate >

friend struct json_interface< voicestate >
friend

Member Data Documentation

◆ channel_id

snowflake dpp::voicestate::channel_id {0}

The channel id this user is connected to.

Note
This may be empty.

◆ flags

uint8_t dpp::voicestate::flags {0}

Voice state flags from dpp::voicestate_flags.

◆ guild_id

snowflake dpp::voicestate::guild_id {0}

Optional: The guild id this voice state is for.

◆ request_to_speak

time_t dpp::voicestate::request_to_speak {0}

The time at which the user requested to speak.

Note
If the user never requested to speak, this is 0.

◆ session_id

std::string dpp::voicestate::session_id

The session id for this voice state.

◆ shard

class discord_client* dpp::voicestate::shard

Owning shard.

◆ user_id

snowflake dpp::voicestate::user_id {0}

The user id this voice state is for.

D++ Library version 9.0.13D++ Library version 9.0.12D++ Library version 9.0.11D++ Library version 9.0.10D++ Library version 9.0.9D++ Library version 9.0.8D++ Library version 9.0.7D++ Library version 9.0.6D++ Library version 9.0.5D++ Library version 9.0.4D++ Library version 9.0.3D++ Library version 9.0.2D++ Library version 9.0.1D++ Library version 9.0.0D++ Library version 1.0.2D++ Library version 1.0.1D++ Library version 1.0.0