aegis.cpp
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Friends | List of all members
aegis::gateway::objects::embed Class Reference

#include <embed.hpp>

Public Member Functions

embedfields (const std::vector< objects::field > &flds) noexcept
 Adds a new embed field. More...
 
embedtitle (const std::string &str) noexcept
 Sets the title of the embed. More...
 
embedfooter (const objects::footer ftr) noexcept
 Sets the footer of the embed. More...
 
embeddescription (const std::string &str) noexcept
 Sets the description of the embed. More...
 
embedurl (const std::string &str) noexcept
 Sets the url of the embed. More...
 
embedtimestamp (const std::string &str) noexcept
 Sets the timestamp of the embed. More...
 
embedcolor (const int32_t clr) noexcept
 Sets the color of the embed. More...
 
embedthumbnail (const objects::thumbnail &tn) noexcept
 Sets the thumbnail of the embed. More...
 
embedimage (const objects::image &img) noexcept
 Sets the image of the embed. More...
 
std::vector< objects::field > & fields () noexcept
 Get the fields.
 
std::string & title () noexcept
 Get the title.
 
objects::footerfooter () noexcept
 Get the footer.
 
std::string & description () noexcept
 Get the description.
 
std::string & url () noexcept
 Get the url.
 
std::string & timestamp () noexcept
 Get the timestamp.
 
int32_t & color () noexcept
 Get the color.
 
objects::thumbnailthumbnail () noexcept
 Get the thumbnail.
 
objects::imageimage () noexcept
 Get the image.
 

Friends

void from_json (const nlohmann::json &j, embed &m)
 
void to_json (nlohmann::json &j, const embed &m)
 

Detailed Description

Todo:
Needs documentation

Member Function Documentation

embed& aegis::gateway::objects::embed::color ( const int32_t  clr)
noexcept

Sets the color of the embed.

Parameters
clrColor to set
embed& aegis::gateway::objects::embed::description ( const std::string &  str)
noexcept

Sets the description of the embed.

Parameters
strDescription to set
embed& aegis::gateway::objects::embed::fields ( const std::vector< objects::field > &  flds)
noexcept

Adds a new embed field.

Parameters
nameName of the field
valueText to be shown within field
is_inlineSets whether the field is inline
embed& aegis::gateway::objects::embed::footer ( const objects::footer  ftr)
noexcept

Sets the footer of the embed.

Parameters
strFooter to set
embed& aegis::gateway::objects::embed::image ( const objects::image img)
noexcept

Sets the image of the embed.

Parameters
imgImage to set
embed& aegis::gateway::objects::embed::thumbnail ( const objects::thumbnail tn)
noexcept

Sets the thumbnail of the embed.

Parameters
tnThumbnail to set
embed& aegis::gateway::objects::embed::timestamp ( const std::string &  str)
noexcept

Sets the timestamp of the embed.

Parameters
strTimestamp to set
embed& aegis::gateway::objects::embed::title ( const std::string &  str)
noexcept

Sets the title of the embed.

Parameters
strTitle to set
embed& aegis::gateway::objects::embed::url ( const std::string &  str)
noexcept

Sets the url of the embed.

Parameters
strUrl to set

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