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

Data representing an input-event, which is any Message or Interaction that is coming into the bot as an input. More...

#include <FoundationEntities.hpp>

Public Member Functions

Snowflake getApplicationId () const
 Returns the application id. More...
 
Snowflake getAuthorId () const
 Returns the User id of the last requester of this input-event. More...
 
std::string getAvatarUrl () const
 Gets the avatar Url of the last User to trigger this input-event. More...
 
Snowflake getChannelId () const
 Returns the Channel id of this input-event. More...
 
std::vector< ActionRowDatagetComponents () const
 Returns the Message components that are on the Message, if applicable. More...
 
std::vector< EmbedDatagetEmbeds () const
 Returns the Message embeds that are on the Message, if applicable. More...
 
Snowflake getGuildId () const
 Returns the Guild id, of this input-event. More...
 
InteractionData getInteractionData () const
 Returns the InteractionData, if applicable, of this input-event. More...
 
Snowflake getInteractionId () const
 Returns the Interaction id, if appplicable, of this input-event. More...
 
std::string getInteractionToken () const
 Returns the Interaction token, if applicable, of this input-event. More...
 
MessageData getMessageData () const
 Returns the Message data, if applicable, of this input-event. More...
 
Snowflake getMessageId () const
 Returns the Message id, if applicable, of this input-event. More...
 
std::string getUserName () const
 Returns the userName of the last User to trigger this input-event. More...
 

Public Data Members

InputEventResponseType responseType {}
 The type of response that this input value represents.
 

Member Function Documentation

◆ getApplicationId()

Snowflake DiscordCoreAPI::InputEventData::getApplicationId ( ) const

Returns the application id.

Returns
Snowflake A Snowflake containing the application id.

Definition at line 3592 of file FoundationEntities.cpp.

◆ getAuthorId()

Snowflake DiscordCoreAPI::InputEventData::getAuthorId ( ) const

Returns the User id of the last requester of this input-event.

Returns
Snowflake A Snowflake containing the author's id.

Definition at line 3584 of file FoundationEntities.cpp.

◆ getAvatarUrl()

std::string DiscordCoreAPI::InputEventData::getAvatarUrl ( ) const

Gets the avatar Url of the last User to trigger this input-event.

Returns
std::string A string containing the avatar Url.

Definition at line 3568 of file FoundationEntities.cpp.

◆ getChannelId()

Snowflake DiscordCoreAPI::InputEventData::getChannelId ( ) const

Returns the Channel id of this input-event.

Returns
Snowflake A Snowflake containing the Channel id.

Definition at line 3596 of file FoundationEntities.cpp.

Here is the caller graph for this function:

◆ getComponents()

std::vector< ActionRowData > DiscordCoreAPI::InputEventData::getComponents ( ) const

Returns the Message components that are on the Message, if applicable.

Returns
std::vector A vector containing ActionRowData.

Definition at line 3580 of file FoundationEntities.cpp.

◆ getEmbeds()

std::vector< EmbedData > DiscordCoreAPI::InputEventData::getEmbeds ( ) const

Returns the Message embeds that are on the Message, if applicable.

Returns
std::vector A vector containing the EmbedData.

Definition at line 3576 of file FoundationEntities.cpp.

◆ getGuildId()

Snowflake DiscordCoreAPI::InputEventData::getGuildId ( ) const

Returns the Guild id, of this input-event.

Returns
Snowflake A Snowflake containing the Guild id.

Definition at line 3604 of file FoundationEntities.cpp.

◆ getInteractionData()

InteractionData DiscordCoreAPI::InputEventData::getInteractionData ( ) const

Returns the Interaction data, if applicable, of this input-event.

Returns
InteractionData An InteractionData structure.

Definition at line 3612 of file FoundationEntities.cpp.

Here is the caller graph for this function:

◆ getInteractionId()

Snowflake DiscordCoreAPI::InputEventData::getInteractionId ( ) const

Returns the Interaction id, if appplicable, of this input-event.

Returns
Snowflake A Snowflake containing the Interaction id.

Definition at line 3588 of file FoundationEntities.cpp.

◆ getInteractionToken()

std::string DiscordCoreAPI::InputEventData::getInteractionToken ( ) const

Returns the Interaction token, if applicable, of this input-event.

Returns
std::string A string containing the Interaction token.

Definition at line 3600 of file FoundationEntities.cpp.

◆ getMessageData()

MessageData DiscordCoreAPI::InputEventData::getMessageData ( ) const

Returns the Message data, if applicable, of this input-event.

Returns
MessageData A MessageData structure.

Definition at line 3616 of file FoundationEntities.cpp.

◆ getMessageId()

Snowflake DiscordCoreAPI::InputEventData::getMessageId ( ) const

Returns the Message id, if applicable, of this input-event.

Returns
Snowflake A Snowflake containing the Message id.

Definition at line 3608 of file FoundationEntities.cpp.

Here is the caller graph for this function:

◆ getUserName()

std::string DiscordCoreAPI::InputEventData::getUserName ( ) const

Returns the userName of the last User to trigger this input-event.

Returns
std::string A string containing the User name.

Definition at line 3564 of file FoundationEntities.cpp.


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