dpp::command_permission Class Reference

Application command permissions allow you to enable or disable commands for specific users or roles within a guild. More...

#include <appcommand.h>

Inheritance diagram for dpp::command_permission:

Collaboration diagram for dpp::command_permission:

Public Member Functions
	command_permission ()=default
	Construct a new command permission object. More...
virtual	~command_permission ()=default
	command_permission (snowflake id, const command_permission_type t, bool permission)
	Construct a new command permission object. More...
command_permission &	fill_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
snowflake	id
	the ID of the role or user More...
command_permission_type	type
	the type of permission More...
bool	permission
	true to allow, false, to disallow More...

Protected Member Functions
command_permission &	fill_from_json_impl (nlohmann::json *j)
	Fill object properties from JSON. More...

Friends
struct	json_interface< command_permission >

Detailed Description

Application command permissions allow you to enable or disable commands for specific users or roles within a guild.

Constructor & Destructor Documentation

command_permission() [1/2]

dpp::command_permission::command_permission ( )

default

Construct a new command permission object.

~command_permission()

virtual dpp::command_permission::~command_permission ( )

virtualdefault

command_permission() [2/2]

dpp::command_permission::command_permission	(	snowflake	id,
		const command_permission_type	t,
		bool	permission
	)

Construct a new command permission object.

Parameters

id	The ID of the role or user
t	The permission type
permission	True to allow, false, to disallow

Member Function Documentation

build_json()

std::string dpp::json_interface< command_permission >::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()

command_permission & dpp::json_interface< command_permission >::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()

command_permission & dpp::command_permission::fill_from_json_impl ( nlohmann::json *  j )

protected

Fill object properties from JSON.

Parameters

j	JSON to fill from

Returns

command_permission& Reference to self

to_json()

auto dpp::json_interface< command_permission >::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

Friends And Related Function Documentation

json_interface< command_permission >

friend struct json_interface< command_permission >

friend

Member Data Documentation

id

snowflake dpp::command_permission::id

the ID of the role or user

permission

bool dpp::command_permission::permission

true to allow, false, to disallow

type

command_permission_type dpp::command_permission::type

the type of permission