DiscordCoreAPI
A Discord bot library written in C++, with custom asynchronous coroutines.
Loading...
Searching...
No Matches
DiscordCoreAPI::CommandData Class Reference

Command data, for functions executed by the CommandController. More...

#include <FoundationEntities.hpp>

Inheritance diagram for DiscordCoreAPI::CommandData:
[legend]

Public Member Functions

ChannelData getChannelData () noexcept
 Returns the Channel of this input-event.
 
JsonifierValue getCommandArguments () noexcept
 Returns the collection of command inputs/options for this command.
 
std::string getCommandName () noexcept
 Returns the name of this entered command.
 
DiscordCoreClientgetDiscordCoreClient () noexcept
 Returns a pointer to the currently active DiscordCoreClient class.
 
GuildData getGuildData () noexcept
 Returns the Guild of this input-event.
 
GuildMemberData getGuildMemberData () noexcept
 Returns the GuildMember of this input-event.
 
InputEventData getInputEventData () noexcept
 Returns the InputEventData for this command.
 
InteractionData getInteractionData () noexcept
 Returns the Interaction data, if appplicable, of this input-event.
 
MessageData getMessageData () noexcept
 Returns the Message data, if applicable, of this input-event.
 
std::string getSubCommandGroupName () noexcept
 Returns the subcommand-name of this entered command group.
 
std::string getSubCommandName () noexcept
 Returns the subcommand-name of this entered command.
 
UserData getUserData () noexcept
 Returns the User of this input-event.
 

Member Function Documentation

◆ getChannelData()

ChannelData DiscordCoreAPI::CommandData::getChannelData ( )
noexcept
Returns
ChannelData A Channel containing the Channel data.

Definition at line 4012 of file FoundationEntities.cpp.

Here is the call graph for this function:

◆ getCommandArguments()

JsonifierValue DiscordCoreAPI::CommandData::getCommandArguments ( )
noexcept
Returns
JsonifierValue A JsonifierValue containing the arguments entered with this command.

Definition at line 4040 of file FoundationEntities.cpp.

◆ getCommandName()

std::string DiscordCoreAPI::CommandData::getCommandName ( )
noexcept
Returns
std::string A string containing the name of this command.

Definition at line 4028 of file FoundationEntities.cpp.

◆ getDiscordCoreClient()

DiscordCoreClient * DiscordCoreAPI::CommandData::getDiscordCoreClient ( )
noexcept
Returns
DiscordCoreClient* A pointer to the currently active DiscordCoreClient.

◆ getGuildData()

GuildData DiscordCoreAPI::CommandData::getGuildData ( )
noexcept
Returns
GuildData A Guild containing the Guild data.

Definition at line 4020 of file FoundationEntities.cpp.

Here is the call graph for this function:

◆ getGuildMemberData()

GuildMemberData DiscordCoreAPI::CommandData::getGuildMemberData ( )
noexcept
Returns
GuildMemberData A GuildMember containing the GuildMember data.

Definition at line 4008 of file FoundationEntities.cpp.

Here is the call graph for this function:

◆ getInputEventData()

InputEventData DiscordCoreAPI::CommandData::getInputEventData ( )
noexcept
Returns
InputEventData An InputEventData containing the data associated with this command.

Definition at line 4044 of file FoundationEntities.cpp.

◆ getInteractionData()

InteractionData DiscordCoreAPI::CommandData::getInteractionData ( )
noexcept
Returns
InteractionData A Snowflake containing the Interaction data.

Definition at line 4004 of file FoundationEntities.cpp.

◆ getMessageData()

MessageData DiscordCoreAPI::CommandData::getMessageData ( )
noexcept
Returns
MessageData A MessageData structure.

Definition at line 4016 of file FoundationEntities.cpp.

Here is the call graph for this function:

◆ getSubCommandGroupName()

std::string DiscordCoreAPI::CommandData::getSubCommandGroupName ( )
noexcept
Returns
std::string A string containing the name of this sub-command's group.

Definition at line 4036 of file FoundationEntities.cpp.

◆ getSubCommandName()

std::string DiscordCoreAPI::CommandData::getSubCommandName ( )
noexcept
Returns
std::string A string containing the name of this sub-command.

Definition at line 4032 of file FoundationEntities.cpp.

◆ getUserData()

UserData DiscordCoreAPI::CommandData::getUserData ( )
noexcept
Returns
UserData A User containing the User data.

Definition at line 4024 of file FoundationEntities.cpp.

Here is the call graph for this function:

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