DiscordCoreAPI::EmbedData Class Reference

Embed data. More...

#include <FoundationEntities.hpp>

Public Member Functions
EmbedData &	addField (const std::string &name, const std::string &value, bool Inline=true)
	Adds a field to the embed.
EmbedData &	setAuthor (const std::string &authorName, const std::string &authorAvatarUrl="")
	Sets the author's name and avatar for the embed.
EmbedData &	setColor (const std::string &hexColorValueNew)
	Sets the color of the embed, by applying a hex-color value.
EmbedData &	setDescription (const std::string &descriptionNew)
	Sets the description (the main contents) of the embed.
EmbedData &	setFooter (const std::string &footerText, const std::string &footerIconUrlText="")
	Sets the footer's values for the embed.
EmbedData &	setImage (const std::string &imageUrl)
	Sets the image of the embed.
EmbedData &	setThumbnail (const std::string &thumbnailUrl)
	Sets the thumbnail of the embed.
EmbedData &	setTimeStamp (const std::string &timeStamp)
	Sets the timeStamp on the embed.
EmbedData &	setTitle (const std::string &titleNew)
	Sets the title of the embed.

Public Data Members
EmbedAuthorData	author {}
	Embed author data.
std::string	description {}
	Description of the embed.
std::vector< EmbedFieldData >	fields {}
	Array of embed fields.
EmbedFooterData	footer {}
	Embed footer data.
ColorValue	hexColorValue { 0 }
	Hex color value of the embed.
EmbedImageData	image {}
	Embed image data.
EmbedProviderData	provider {}
	Embed provider data.
EmbedThumbnailData	thumbnail {}
	Embed thumbnail data.
std::string	timeStamp {}
	Timestamp to be placed on the embed.
std::string	title {}
	Title of the embed.
std::string	type {}
	Type of the embed.
std::string	url {}
	Url for the embed.
EmbedVideoData	video {}
	Embed video data.

Member Function Documentation

addField()

EmbedData & DiscordCoreAPI::EmbedData::addField	(	const std::string &	name,
		const std::string &	value,
		bool	Inline = true
	)

Parameters

name	The title of the embed field.
value	The contents of the embed field.
Inline	Is it inline with the rest of the fields on the embed?

Returns

EmbedData& A reference to this embed.

Definition at line 3128 of file FoundationEntities.cpp.

setAuthor()

EmbedData & DiscordCoreAPI::EmbedData::setAuthor	(	const std::string &	authorName,
		const std::string &	authorAvatarUrl = ""
	)

Parameters

authorName	The author's name.
authorAvatarUrl	The url to their avatar.

Returns

EmbedData& A reference to this embed.

Definition at line 3111 of file FoundationEntities.cpp.

setColor()

EmbedData & DiscordCoreAPI::EmbedData::setColor

(

const std::string &

hexColorValueNew

)

Parameters

hexColorValueNew

A string containing a hex-number value (Between 0x00 0xFFFFFF).

Returns

EmbedData& A reference to this embed.

Definition at line 3142 of file FoundationEntities.cpp.

setDescription()

EmbedData & DiscordCoreAPI::EmbedData::setDescription

(

const std::string &

descriptionNew

)

Parameters

descriptionNew

The contents of the description to set.

Returns

EmbedData& A reference to this embed.

Definition at line 3137 of file FoundationEntities.cpp.

setFooter()

EmbedData & DiscordCoreAPI::EmbedData::setFooter	(	const std::string &	footerText,
		const std::string &	footerIconUrlText = ""
	)

Parameters

footerText	The footer's text.
footerIconUrlText	Url to the footer's icon.

Returns

EmbedData& A reference to this embed.

Definition at line 3117 of file FoundationEntities.cpp.

setImage()

EmbedData & DiscordCoreAPI::EmbedData::setImage

(

const std::string &

imageUrl

)

Parameters

imageUrl

The url of the image to be set on the embed.

Returns

EmbedData& A reference to this embed.

Definition at line 3157 of file FoundationEntities.cpp.

setThumbnail()

EmbedData & DiscordCoreAPI::EmbedData::setThumbnail

(

const std::string &

thumbnailUrl

)

Parameters

thumbnailUrl

The url to the thumbnail to be used.

Returns

EmbedData& A reference to this embed.

Definition at line 3147 of file FoundationEntities.cpp.

setTimeStamp()

EmbedData & DiscordCoreAPI::EmbedData::setTimeStamp

(

const std::string &

timeStamp

)

Parameters

timeStamp

The timeStamp to be set.

Returns

EmbedData& A reference to this embed.

Definition at line 3123 of file FoundationEntities.cpp.

setTitle()

EmbedData & DiscordCoreAPI::EmbedData::setTitle

(

const std::string &

titleNew

)

Parameters

titleNew

A string containing the desired title.

Returns

EmbedData& A reference to this embed.

Definition at line 3152 of file FoundationEntities.cpp.

---

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

• FoundationEntities.hpp
• FoundationEntities.cpp