dpp::voiceregion Class Reference

Represents a voice region on discord. More...

#include <voiceregion.h>

Inheritance diagram for dpp::voiceregion:

Collaboration diagram for dpp::voiceregion:

Public Member Functions
	voiceregion ()
	Construct a new voiceregion object. More...
	~voiceregion ()
	Destroy the voiceregion object. More...
voiceregion &	fill_from_json (nlohmann::json *j)
	Fill object properties from JSON. More...
std::string	build_json (bool with_id=false) const
	Build a json string for this object. More...
bool	is_optimal () const
	True if is the optimal voice server. More...
bool	is_deprecated () const
	True if is a deprecated voice server. More...
bool	is_custom () const
	True if is a custom voice server. More...
bool	is_vip () const
	True if is a VIP voice server. More...
voiceregion &	parse_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. More...

Public Attributes
std::string	id
	Voice server ID. More...
std::string	name
	Voice server name. More...
uint8_t	flags
	Flags bitmap. More...

Detailed Description

Represents a voice region on discord.

Constructor & Destructor Documentation

voiceregion()

dpp::voiceregion::voiceregion

(

)

Construct a new voiceregion object.

~voiceregion()

dpp::voiceregion::~voiceregion

(

)

Destroy the voiceregion object.

Member Function Documentation

build_json()

std::string dpp::voiceregion::build_json ( bool  with_id = false ) const

virtual

Build a json string for this object.

Parameters

with_id

Add ID to output

Returns

std::string JSON string

Reimplemented from dpp::json_interface< voiceregion >.

fill_from_json()

voiceregion & dpp::voiceregion::fill_from_json

(

nlohmann::json *

j

)

Fill object properties from JSON.

Parameters

j	JSON to fill from

Returns

voiceregion& Reference to self

is_custom()

bool dpp::voiceregion::is_custom

(

)

const

True if is a custom voice server.

Returns

true if custom

is_deprecated()

bool dpp::voiceregion::is_deprecated

(

)

const

True if is a deprecated voice server.

Returns

true if deprecated

is_optimal()

bool dpp::voiceregion::is_optimal

(

)

const

True if is the optimal voice server.

Returns

true if optimal

is_vip()

bool dpp::voiceregion::is_vip

(

)

const

True if is a VIP voice server.

Returns

true if VIP

parse_from_json()

voiceregion & dpp::json_interface< voiceregion >::parse_from_json ( nlohmann::json *  j )

inlineinherited

Convert object from nlohmann::json.

Parameters

j	nlohmann::json object

Returns

T& Reference to self for fluent calling

Member Data Documentation

flags

uint8_t dpp::voiceregion::flags

Flags bitmap.

id

std::string dpp::voiceregion::id

Voice server ID.

name

std::string dpp::voiceregion::name

Voice server name.