discordpp::AdditionalContent Class Reference

Detailed Description

Contains information about non-text content in a message that likely cannot be rendered in game such as images, videos, embeds, polls, and more.

Public Member Functions
	AdditionalContent (AdditionalContent &&other) noexcept
	Move constructor for AdditionalContent.
AdditionalContent &	operator= (AdditionalContent &&other) noexcept
	Move assignment operator for AdditionalContent.
	operator bool () const
	Returns true if the instance contains a valid object.
	AdditionalContent (const AdditionalContent &arg0)
	Copy constructor for AdditionalContent.
AdditionalContent &	operator= (const AdditionalContent &arg0)
	Copy assignment operator for AdditionalContent.
bool	Equals (discordpp::AdditionalContent rhs) const
	Compares each field of the AdditionalContent struct for equality.
discordpp::AdditionalContentType	Type () const
	Represents the type of additional content in the message.
void	SetType (discordpp::AdditionalContentType Type)
	Setter for AdditionalContent::Type.
std::optional< std::string >	Title () const
	When the additional content is a poll or thread, this field will contain the name of the poll or thread.
void	SetTitle (std::optional< std::string > Title)
	Setter for AdditionalContent::Title.
uint8_t	Count () const
	Represents the number of pieces of additional content so you could for example renders "2 additional images".
void	SetCount (uint8_t Count)
	Setter for AdditionalContent::Count.

Static Public Member Functions
static std::string	TypeToString (discordpp::AdditionalContentType type)
	Converts the AdditionalContentType enum to a string.

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

Constructor & Destructor Documentation

AdditionalContent() [1/2]

discordpp::AdditionalContent::AdditionalContent ( AdditionalContent && other )

noexcept

Move constructor for AdditionalContent.

AdditionalContent() [2/2]

discordpp::AdditionalContent::AdditionalContent

(

const AdditionalContent &

arg0

)

Copy constructor for AdditionalContent.

Member Function Documentation

Count()

uint8_t discordpp::AdditionalContent::Count

(

)

const

Represents the number of pieces of additional content so you could for example renders "2 additional images".

Equals()

bool discordpp::AdditionalContent::Equals

(

discordpp::AdditionalContent

rhs

)

const

Compares each field of the AdditionalContent struct for equality.

operator bool()

discordpp::AdditionalContent::operator bool ( ) const

inline

Returns true if the instance contains a valid object.

operator=() [1/2]

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

noexcept

Move assignment operator for AdditionalContent.

operator=() [2/2]

AdditionalContent & discordpp::AdditionalContent::operator=

(

const AdditionalContent &

arg0

)

Copy assignment operator for AdditionalContent.

SetCount()

void discordpp::AdditionalContent::SetCount

(

uint8_t

Count

)

Setter for AdditionalContent::Count.

SetTitle()

void discordpp::AdditionalContent::SetTitle

(

std::optional< std::string >

Title

)

Setter for AdditionalContent::Title.

SetType()

void discordpp::AdditionalContent::SetType

(

discordpp::AdditionalContentType

Type

)

Setter for AdditionalContent::Type.

Title()

std::optional< std::string > discordpp::AdditionalContent::Title

(

)

const

When the additional content is a poll or thread, this field will contain the name of the poll or thread.

Type()

discordpp::AdditionalContentType discordpp::AdditionalContent::Type

(

)

const

Represents the type of additional content in the message.

TypeToString()

static std::string discordpp::AdditionalContent::TypeToString ( discordpp::AdditionalContentType type )

static

Converts the AdditionalContentType enum to a string.

Member Data Documentation

nullobj

const AdditionalContent discordpp::AdditionalContent::nullobj

static

Uninitialized instance of AdditionalContent.