Data structure representing a single Guild. More...

Inheritance diagram for DiscordCoreAPI::GuildData:

Public Member Functions
VoiceConnection *	connectToVoice (const Snowflake guildMemberId, const Snowflake channelId=Snowflake{}, bool selfDeaf=false, bool selfMute=false, StreamInfo streamInfo=StreamInfo{})
	For connecting to an individual voice channel.

Public Member Functions inherited from DiscordCoreAPI::DiscordEntity
std::string	getCreatedAtTimestamp (TimeFormat timeFormat)
	Converts the snowflake-id into a time and date stamp.

Public Data Members
std::vector< Snowflake >	channels {}
	Array of Guild channels.

DiscordCoreClient *	discordCoreClient { nullptr }
	A pointer to the DiscordCoreClient.

std::vector< Snowflake >	emoji {}
	Array of Guild channels.

GuildFlags	flags {}
	Guild flags.

std::vector< Snowflake >	guildScheduledEvents {}
	Array of Guild channels.

IconHash	icon {}
	Url to the Guild's icon.

TimeStamp	joinedAt {}
	When the bot joined this Guild.

uint32_t	memberCount {}
	Member count.

std::vector< Snowflake >	members {}
	Array of GuildMembers.

StringWrapper	name {}
	The Guild's name.

Snowflake	ownerId {}
	User id of the Guild's owner.

std::vector< PresenceUpdateData >	presences {}
	Presence states for each of the GuildMembers..

std::vector< Snowflake >	roles {}
	Array of Guild roles.

std::vector< Snowflake >	stageInstances {}
	Array of Guild channels.

std::vector< Snowflake >	stickers {}
	Array of Guild channels.

std::vector< Snowflake >	threads {}
	Array of Guild channels.

VoiceConnection *	voiceConnectionPtr { nullptr }
	A pointer to the VoiceConnection, if present.

Public Data Members inherited from DiscordCoreAPI::DiscordEntity
Snowflake	id {}

Member Function Documentation

◆ connectToVoice()

VoiceConnection * DiscordCoreAPI::GuildData::connectToVoice	(	const Snowflake	guildMemberId,
		const Snowflake	channelId = `Snowflake{}`,
		bool	selfDeaf = `false`,
		bool	selfMute = `false`,
		StreamInfo	streamInfo = `StreamInfo{}`
	)

Parameters

guildMemberId	An id of the guild member who's current voice channel to connect to.
channelId	An id of the voice channel to connect to.
selfDeaf	Whether or not to self-deafen the bot.
selfMute	Whether or not to self-mute the bot.
streamInfo	For usage with the Vc-to-Vc audio streaming option.

Returns: VoiceConnection* A pointer to the currently held voice connection, or nullptr if it failed to connect.

Definition at line 1340 of file FoundationEntities.cpp.

Here is the call graph for this function:

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