dpp::interaction Class Reference

An interaction represents a user running a command and arrives via the dpp::cluster::on_interaction_create event. More...

#include <slashcommand.h>

Inheritance diagram for dpp::interaction:

Collaboration diagram for dpp::interaction:

Public Member Functions
std::string	build_json (bool with_id=false) const
	Build a json string for this object. More...
interaction &	fill_from_json (nlohmann::json *j)
	Fill object properties from JSON. More...

Public Attributes
snowflake	application_id
	id of the application this interaction is for More...
snowflake	channel_id
	Optional: the channel it was sent from. More...
std::variant< command_interaction, component_interaction >	data
	Optional: the command data payload. More...
snowflake	guild_id
	Optional: the guild it was sent from. More...
snowflake	id
guild_member	member
	Optional: guild member data for the invoking user, including permissions. More...
snowflake	message_id
	Originating message id. More...
command_resolved	resolved
	Resolved user/role etc. More...
std::string	token
	a continuation token for responding to the interaction More...
uint8_t	type
	the type of interaction More...
user	usr
	Optional: user object for the invoking user, if invoked in a DM. More...
uint8_t	version
	read-only property, always 1 More...

Detailed Description

An interaction represents a user running a command and arrives via the dpp::cluster::on_interaction_create event.

Member Function Documentation

build_json()

std::string dpp::interaction::build_json

(

bool

with_id = false

)

const

Build a json string for this object.

Parameters

with_id

True if to include the ID in the JSON

Returns

std::string JSON string

fill_from_json()

interaction & dpp::interaction::fill_from_json

(

nlohmann::json *

j

)

Fill object properties from JSON.

Parameters

j	JSON to fill from

Returns

interaction& Reference to self

Member Data Documentation

application_id

snowflake dpp::interaction::application_id

id of the application this interaction is for

channel_id

snowflake dpp::interaction::channel_id

Optional: the channel it was sent from.

data

std::variant<command_interaction, component_interaction> dpp::interaction::data

Optional: the command data payload.

guild_id

snowflake dpp::interaction::guild_id

Optional: the guild it was sent from.

id

snowflake dpp::managed::id

inherited

Unique ID of object

member

guild_member dpp::interaction::member

Optional: guild member data for the invoking user, including permissions.

message_id

snowflake dpp::interaction::message_id

Originating message id.

resolved

command_resolved dpp::interaction::resolved

Resolved user/role etc.

token

std::string dpp::interaction::token

a continuation token for responding to the interaction

type

uint8_t dpp::interaction::type

the type of interaction

usr

user dpp::interaction::usr

Optional: user object for the invoking user, if invoked in a DM.

version

uint8_t dpp::interaction::version

read-only property, always 1