D++ (DPP)
C++ Discord API Bot Library
dpp::sticker_pack Struct Reference

Represents a sticker pack (the built in groups of stickers that all nitro users get to use) More...

+ Inheritance diagram for dpp::sticker_pack:
+ Collaboration diagram for dpp::sticker_pack:

Public Member Functions

 sticker_pack ()
 Construct a new sticker pack object. More...
 
virtual ~sticker_pack ()=default
 
constexpr double get_creation_time () const noexcept
 Get the creation time of this object according to Discord. More...
 
constexpr bool operator== (const managed &other) const noexcept
 Comparison operator for comparing two managed objects by id. More...
 
constexpr bool operator!= (const managed &other) const noexcept
 Comparison operator for comparing two managed objects by id. More...
 
sticker_packfill_from_json (nlohmann::json *j)
 Convert object from nlohmann::json. More...
 
auto to_json (bool with_id=false) const
 Convert object to nlohmann::json. More...
 
std::string build_json (bool with_id=false) const
 Convert object to json string. More...
 

Public Attributes

std::map< snowflake, stickerstickers
 The stickers in the pack. More...
 
std::string name
 Name of the sticker pack. More...
 
snowflake sku_id
 ID of the pack's SKU. More...
 
snowflake cover_sticker_id
 Optional: ID of a sticker in the pack which is shown as the pack's icon. More...
 
std::string description
 Description of the sticker pack. More...
 
snowflake banner_asset_id
 ID of the sticker pack's banner image. More...
 
snowflake id = {}
 Unique ID of object set by Discord. This value contains a timestamp, worker ID, internal server ID, and an incrementing value. Only the timestamp is relevant to us as useful metadata. More...
 

Protected Member Functions

sticker_packfill_from_json_impl (nlohmann::json *j)
 
virtual json to_json_impl (bool with_id=true) const
 

Friends

struct json_interface< sticker_pack >
 

Detailed Description

Represents a sticker pack (the built in groups of stickers that all nitro users get to use)

Constructor & Destructor Documentation

◆ sticker_pack()

dpp::sticker_pack::sticker_pack ( )

Construct a new sticker pack object.

◆ ~sticker_pack()

virtual dpp::sticker_pack::~sticker_pack ( )
virtualdefault

Member Function Documentation

◆ build_json()

std::string dpp::json_interface< sticker_pack >::build_json ( bool  with_id = false) const
inlineinherited

Convert object to json string.

Parameters
with_idWhether to include the ID or not
Note
Some fields are conditionally filled, do not rely on all fields being present
Returns
std::string Json built from the structure

◆ fill_from_json()

sticker_pack & dpp::json_interface< sticker_pack >::fill_from_json ( nlohmann::json *  j)
inlineinherited

Convert object from nlohmann::json.

Parameters
jnlohmann::json object
Returns
T& Reference to self for fluent calling

◆ fill_from_json_impl()

sticker_pack& dpp::sticker_pack::fill_from_json_impl ( nlohmann::json *  j)
protected

Read class values from json object

Parameters
jA json object to read from
Returns
A reference to self

◆ get_creation_time()

constexpr double dpp::managed::get_creation_time ( ) const
inlineconstexprnoexceptinherited

Get the creation time of this object according to Discord.

Returns
double creation time inferred from the snowflake ID. The minimum possible value is the first second of 2015.

◆ operator!=()

constexpr bool dpp::managed::operator!= ( const managed other) const
inlineconstexprnoexceptinherited

Comparison operator for comparing two managed objects by id.

Parameters
otherOther object to compare against
Returns
true objects are not the same id
false objects are the same id

◆ operator==()

constexpr bool dpp::managed::operator== ( const managed other) const
inlineconstexprnoexceptinherited

Comparison operator for comparing two managed objects by id.

Parameters
otherOther object to compare against
Returns
true objects are the same id
false objects are not the same id

◆ to_json()

auto dpp::json_interface< sticker_pack >::to_json ( bool  with_id = false) const
inlineinherited

Convert object to nlohmann::json.

Parameters
with_idWhether to include the ID or not
Note
Some fields are conditionally filled, do not rely on all fields being present
Returns
json Json built from the structure

◆ to_json_impl()

virtual json dpp::sticker_pack::to_json_impl ( bool  with_id = true) const
protectedvirtual

Build JSON from this object.

Parameters
with_idTrue if the ID is to be set in the JSON structure
Returns
The JSON of the invite

Friends And Related Function Documentation

◆ json_interface< sticker_pack >

friend struct json_interface< sticker_pack >
friend

Member Data Documentation

◆ banner_asset_id

snowflake dpp::sticker_pack::banner_asset_id

ID of the sticker pack's banner image.

◆ cover_sticker_id

snowflake dpp::sticker_pack::cover_sticker_id

Optional: ID of a sticker in the pack which is shown as the pack's icon.

◆ description

std::string dpp::sticker_pack::description

Description of the sticker pack.

◆ id

snowflake dpp::managed::id = {}
inherited

Unique ID of object set by Discord. This value contains a timestamp, worker ID, internal server ID, and an incrementing value. Only the timestamp is relevant to us as useful metadata.

◆ name

std::string dpp::sticker_pack::name

Name of the sticker pack.

◆ sku_id

snowflake dpp::sticker_pack::sku_id

ID of the pack's SKU.

◆ stickers

std::map<snowflake, sticker> dpp::sticker_pack::stickers

The stickers in the pack.

D++ Library version 9.0.13D++ Library version 9.0.12D++ Library version 9.0.11D++ Library version 9.0.10D++ Library version 9.0.9D++ Library version 9.0.8D++ Library version 9.0.7D++ Library version 9.0.6D++ Library version 9.0.5D++ Library version 9.0.4D++ Library version 9.0.3D++ Library version 9.0.2D++ Library version 9.0.1D++ Library version 9.0.0D++ Library version 1.0.2D++ Library version 1.0.1D++ Library version 1.0.0