discordpp::CallInfoHandle Class Reference

Detailed Description

Convenience class that represents the state of a single Discord call in a lobby.

Public Member Functions
	CallInfoHandle (CallInfoHandle &&other) noexcept
	Move constructor for CallInfoHandle.
CallInfoHandle &	operator= (CallInfoHandle &&other) noexcept
	Move assignment operator for CallInfoHandle.
	operator bool () const
	Returns true if the instance contains a valid object.
	CallInfoHandle (const CallInfoHandle &other)
	Copy constructor for CallInfoHandle.
CallInfoHandle &	operator= (const CallInfoHandle &other)
	Copy assignment operator for CallInfoHandle.
uint64_t	ChannelId () const
	Returns the lobby ID of the call.
std::vector< uint64_t >	GetParticipants () const
	Returns a list of the user IDs of the participants in the call.
std::optional< discordpp::VoiceStateHandle >	GetVoiceStateHandle (uint64_t userId) const
	Accesses the voice state for a single user so you can know if they have muted or deafened themselves.
uint64_t	GuildId () const
	Returns the lobby ID of the call.

Static Public Attributes
static const CallInfoHandle	nullobj
	Uninitialized instance of CallInfoHandle.

Constructor & Destructor Documentation

CallInfoHandle() [1/2]

discordpp::CallInfoHandle::CallInfoHandle ( CallInfoHandle && other )

noexcept

Move constructor for CallInfoHandle.

CallInfoHandle() [2/2]

discordpp::CallInfoHandle::CallInfoHandle

(

const CallInfoHandle &

other

)

Copy constructor for CallInfoHandle.

Member Function Documentation

ChannelId()

uint64_t discordpp::CallInfoHandle::ChannelId

(

)

const

Returns the lobby ID of the call.

GetParticipants()

std::vector< uint64_t > discordpp::CallInfoHandle::GetParticipants

(

)

const

Returns a list of the user IDs of the participants in the call.

GetVoiceStateHandle()

std::optional< discordpp::VoiceStateHandle > discordpp::CallInfoHandle::GetVoiceStateHandle

(

uint64_t

userId

)

const

Accesses the voice state for a single user so you can know if they have muted or deafened themselves.

GuildId()

uint64_t discordpp::CallInfoHandle::GuildId

(

)

const

Returns the lobby ID of the call.

operator bool()

discordpp::CallInfoHandle::operator bool ( ) const

inline

Returns true if the instance contains a valid object.

operator=() [1/2]

CallInfoHandle & discordpp::CallInfoHandle::operator= ( CallInfoHandle && other )

noexcept

Move assignment operator for CallInfoHandle.

operator=() [2/2]

CallInfoHandle & discordpp::CallInfoHandle::operator=

(

const CallInfoHandle &

other

)

Copy assignment operator for CallInfoHandle.

Member Data Documentation

nullobj

const CallInfoHandle discordpp::CallInfoHandle::nullobj

static

Uninitialized instance of CallInfoHandle.