The application class represents details of a bot application. More...

#include <application.h>

Inheritance diagram for dpp::application:

Collaboration diagram for dpp::application:

Public Member Functions
	application ()

	~application ()

application &	fill_from_json (nlohmann::json *j)

double	get_creation_time () const
	Get the creation time of this object according to Discord. More...

virtual std::string	build_json (bool with_id=false) const
	Build JSON string from the object. More...

Public Attributes
std::string	name
	the name of the app More...

utility::iconhash	icon
	the icon hash of the app (may be empty) More...

std::string	description
	the description of the app More...

std::string	rpc_origins
	Optional: an array of rpc origin urls, if rpc is enabled. More...

bool	bot_public
	when false only app owner can join the app's bot to guilds More...

bool	bot_require_code_grant
	when true the app's bot will only join upon completion of the full oauth2 code grant flow More...

std::string	terms_of_service_url
	Optional: the url of the app's terms of service. More...

std::string	privacy_policy_url
	Optional: the url of the app's privacy policy. More...

user	owner
	Optional: partial user object containing info on the owner of the application. More...

std::string	summary
	if this application is a game sold on Discord, this field will be the summary field for the store page of its primary sku More...

std::string	verify_key
	the hex encoded key for verification in interactions and the GameSDK's GetTicket More...

app_team	team
	if the application belongs to a team, this will be a list of the members of that team (may be empty) More...

snowflake	guild_id
	Optional: if this application is a game sold on Discord, this field will be the guild to which it has been linked. More...

snowflake	primary_sku_id
	Optional: if this application is a game sold on Discord, this field will be the id of the "Game SKU" that is created, if exists. More...

std::string	slug
	Optional: if this application is a game sold on Discord, this field will be the URL slug that links to the store page. More...

utility::iconhash	cover_image
	Optional: the application's default rich presence invite cover image hash. More...

uint32_t	flags
	Optional: the application's public flags. 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...

Detailed Description

The application class represents details of a bot application.

Constructor & Destructor Documentation

◆ application()

dpp::application::application ( )

Constructor

◆ ~application()

dpp::application::~application ( )

Destructor

Member Function Documentation

◆ build_json()

virtual std::string dpp::json_interface< application >::build_json ( bool with_id = false ) const

inlinevirtualinherited

Build JSON string from the object.

Parameters

with_id Include the ID in the JSON

Returns: std::string JSON string version of object

◆ fill_from_json()

application & dpp::application::fill_from_json ( nlohmann::json * j )

Read class values from json object

Parameters

j	A json object to read from

Returns: A reference to self

◆ get_creation_time()

double dpp::managed::get_creation_time ( ) const

inherited

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.

Member Data Documentation

◆ bot_public

bool dpp::application::bot_public

when false only app owner can join the app's bot to guilds

◆ bot_require_code_grant

bool dpp::application::bot_require_code_grant

when true the app's bot will only join upon completion of the full oauth2 code grant flow

◆ cover_image

utility::iconhash dpp::application::cover_image

Optional: the application's default rich presence invite cover image hash.

◆ description

std::string dpp::application::description

the description of the app

◆ flags

uint32_t dpp::application::flags

Optional: the application's public flags.

◆ guild_id

snowflake dpp::application::guild_id

Optional: if this application is a game sold on Discord, this field will be the guild to which it has been linked.

◆ icon

utility::iconhash dpp::application::icon

the icon hash of the app (may be empty)

◆ 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::application::name

the name of the app

◆ owner

user dpp::application::owner

Optional: partial user object containing info on the owner of the application.

◆ primary_sku_id

snowflake dpp::application::primary_sku_id

Optional: if this application is a game sold on Discord, this field will be the id of the "Game SKU" that is created, if exists.

◆ privacy_policy_url

std::string dpp::application::privacy_policy_url

Optional: the url of the app's privacy policy.

◆ rpc_origins

std::string dpp::application::rpc_origins

Optional: an array of rpc origin urls, if rpc is enabled.

◆ slug

std::string dpp::application::slug

Optional: if this application is a game sold on Discord, this field will be the URL slug that links to the store page.

◆ summary

std::string dpp::application::summary

if this application is a game sold on Discord, this field will be the summary field for the store page of its primary sku

◆ team

app_team dpp::application::team

if the application belongs to a team, this will be a list of the members of that team (may be empty)

◆ terms_of_service_url

std::string dpp::application::terms_of_service_url

Optional: the url of the app's terms of service.

◆ verify_key

std::string dpp::application::verify_key

the hex encoded key for verification in interactions and the GameSDK's GetTicket

Public Member Functions

Public Attributes