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...
	command_permission (snowflake id, const command_permission_type t, bool permission)
	Construct a new command permission object. More...
virtual	~command_permission ()=default
virtual std::string	build_json (bool with_id=false) const
	Build JSON string from the object. More...
command_permission &	fill_from_json (nlohmann::json *j)
	Fill object properties from JSON. More...
command_permission &	parse_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. More...

Public Attributes
snowflake	id
	the ID of the role or user More...
bool	permission
	true to allow, false, to disallow More...
command_permission_type	type
	the type of permission More...

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

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

command_permission & dpp::command_permission::fill_from_json

(

nlohmann::json *

j

)

Fill object properties from JSON.

Parameters

j	JSON to fill from

Returns

command_permission& Reference to self

parse_from_json()

command_permission & dpp::json_interface< command_permission >::parse_from_json ( nlohmann::json *  j )

inlineinherited

Convert object from nlohmann::json.

Parameters

j	nlohmann::json object

Returns

T& Reference to self for fluent calling

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