dpp::sticker_pack Struct Reference

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

#include "message.h"

Inheritance diagram for dpp::sticker_pack:

Collaboration diagram for dpp::sticker_pack:

Public Member Functions
std::string	build_json (bool with_id=false) const
	Convert object to json string. More...
sticker_pack &	fill_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. More...
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...
auto	to_json (bool with_id=false) const
	Convert object to nlohmann::json. More...

Public Attributes
snowflake	banner_asset_id {}
	ID of the sticker pack's banner image. More...
snowflake	cover_sticker_id {0}
	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	id = {}
	Unique ID of object set by Discord. More...
std::string	name {}
	Name of the sticker pack. More...
snowflake	sku_id {0}
	ID of the pack's SKU. More...
std::map< snowflake, sticker >	stickers {}
	The stickers in the pack. More...

Protected Member Functions
sticker_pack &	fill_from_json_impl (nlohmann::json *j)
	Read class values from json object. More...
virtual json	to_json_impl (bool with_id=true) const
	Build JSON from this object. More...

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)

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_id

Whether 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

j	nlohmann::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

j	A 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

other

Other 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

other

Other 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_id

Whether 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()

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

protectedvirtual

Build JSON from this object.

Parameters

with_id

True 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 {0}

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.

Referenced by dpp::poll::add_answer(), dpp::cluster::create_webhook(), dpp::cluster::current_user_join_thread(), dpp::invite::fill_from_json_impl(), dpp::command_permission::fill_from_json_impl(), dpp::interaction::get_resolved_role(), dpp::interaction::get_resolved_user(), dpp::cluster::global_bulk_command_create(), dpp::cluster::global_bulk_command_delete(), dpp::cluster::global_command_delete(), dpp::cluster::global_command_edit(), dpp::cluster::guild_ban_delete(), dpp::cluster::guild_command_create(), dpp::cluster::guild_command_edit_permissions(), dpp::cluster::guild_get_integrations(), dpp::events::guild_member_update::handle(), dpp::events::guild_role_create::handle(), dpp::events::channel_create::handle(), dpp::events::voice_state_update::handle(), dpp::discord_voice_client::handle_frame(), main(), dpp::component::set_disabled(), and dpp::select_option::set_label().

name

std::string dpp::sticker_pack::name {}

Name of the sticker pack.

sku_id

snowflake dpp::sticker_pack::sku_id {0}

ID of the pack's SKU.

stickers

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

The stickers in the pack.

---

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

• message.h
• message.cpp