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

An interface class for the Reaction related Discord endpoints. More...

#include <ReactionEntities.hpp>

Static Public Member Functions

static CoRoutine< EmojiDatacreateGuildEmojiAsync (CreateGuildEmojiData dataPackage)
 Creates a single Guild Emoji within a chosen Guild. More...
 
static CoRoutine< ReactioncreateReactionAsync (CreateReactionData dataPackage)
 Creates a Reaction on a Message. More...
 
static CoRoutine< void > deleteAllReactionsAsync (DeleteAllReactionsData dataPackage)
 Deletes all of the Reactions from a given Message. More...
 
static CoRoutine< void > deleteGuildEmojiAsync (DeleteGuildEmojiData dataPackage)
 Deletes a single Guild Emoji within a chosen Guild. More...
 
static CoRoutine< void > deleteOwnReactionAsync (DeleteOwnReactionData dataPackage)
 Deletes your own Reactions from a given Message. More...
 
static CoRoutine< void > deleteReactionsByEmojiAsync (DeleteReactionsByEmojiData dataPackage)
 Deletes all of the Reactions by a specific emoji from a given Message. More...
 
static CoRoutine< void > deleteUserReactionAsync (DeleteUserReactionData dataPackage)
 Deletes all of the Reactions by a specific User from a given Message. More...
 
static CoRoutine< EmojiDataVector > getEmojiListAsync (GetEmojiListData dataPackage)
 Collects a list of Guild Emoji from a chosen Guild. More...
 
static CoRoutine< EmojiDatagetGuildEmojiAsync (GetGuildEmojiData dataPackage)
 Collects a single Guild Emoji from a chosen Guild. More...
 
static CoRoutine< UserVector > getReactionsAsync (GetReactionsData dataPackage)
 Get a list of users that reacted with this emoji. Returns an array of user objects on success. More...
 
static CoRoutine< EmojiDatamodifyGuildEmojiAsync (ModifyGuildEmojiData dataPackage)
 Modifies a single Guild Emoji within a chosen Guild. More...
 

Member Function Documentation

◆ createGuildEmojiAsync()

CoRoutine< EmojiData > DiscordCoreAPI::Reactions::createGuildEmojiAsync ( CreateGuildEmojiData  dataPackage)
static

Creates a single Guild Emoji within a chosen Guild.

Parameters
dataPackageA CreateGuildEmojiData structure.
Returns
A CoRoutine containing an EmojiData.

Definition at line 207 of file ReactionEntities.cpp.

◆ createReactionAsync()

CoRoutine< Reaction > DiscordCoreAPI::Reactions::createReactionAsync ( CreateReactionData  dataPackage)
static

Creates a Reaction on a Message.

Parameters
dataPackageA CreateReactionData structure.
Returns
A CoRoutine containing a Reaction.

Definition at line 98 of file ReactionEntities.cpp.

◆ deleteAllReactionsAsync()

CoRoutine< void > DiscordCoreAPI::Reactions::deleteAllReactionsAsync ( DeleteAllReactionsData  dataPackage)
static

Deletes all of the Reactions from a given Message.

Parameters
dataPackageA DeleteAllReactionsData structure.
Returns
A CoRoutine containing void.

Definition at line 165 of file ReactionEntities.cpp.

◆ deleteGuildEmojiAsync()

CoRoutine< void > DiscordCoreAPI::Reactions::deleteGuildEmojiAsync ( DeleteGuildEmojiData  dataPackage)
static

Deletes a single Guild Emoji within a chosen Guild.

Parameters
dataPackageA DeleteGuildEmojiData structure.
Returns
A CoRoutine containing void.

Definition at line 257 of file ReactionEntities.cpp.

◆ deleteOwnReactionAsync()

CoRoutine< void > DiscordCoreAPI::Reactions::deleteOwnReactionAsync ( DeleteOwnReactionData  dataPackage)
static

Deletes your own Reactions from a given Message.

Parameters
dataPackageA DeleteOwnReactionData structure.
Returns
A CoRoutine containing void.

Definition at line 114 of file ReactionEntities.cpp.

◆ deleteReactionsByEmojiAsync()

CoRoutine< void > DiscordCoreAPI::Reactions::deleteReactionsByEmojiAsync ( DeleteReactionsByEmojiData  dataPackage)
static

Deletes all of the Reactions by a specific emoji from a given Message.

Parameters
dataPackageA DeleteReactionsByEmojiData structure.
Returns
A CoRoutine containing void.

Definition at line 174 of file ReactionEntities.cpp.

◆ deleteUserReactionAsync()

CoRoutine< void > DiscordCoreAPI::Reactions::deleteUserReactionAsync ( DeleteUserReactionData  dataPackage)
static

Deletes all of the Reactions by a specific User from a given Message.

Parameters
dataPackageA DeleteUserReactionData structure.
Returns
A CoRoutine containing void.

Definition at line 130 of file ReactionEntities.cpp.

◆ getEmojiListAsync()

CoRoutine< EmojiDataVector > DiscordCoreAPI::Reactions::getEmojiListAsync ( GetEmojiListData  dataPackage)
static

Collects a list of Guild Emoji from a chosen Guild.

Parameters
dataPackageA GetEmojiListData structure.
Returns
A CoRoutine containing a EmojiDataVector.

Definition at line 189 of file ReactionEntities.cpp.

◆ getGuildEmojiAsync()

CoRoutine< EmojiData > DiscordCoreAPI::Reactions::getGuildEmojiAsync ( GetGuildEmojiData  dataPackage)
static

Collects a single Guild Emoji from a chosen Guild.

Parameters
dataPackageA GetGuildEmojiData structure.
Returns
A CoRoutine containing an EmojiData.

Definition at line 198 of file ReactionEntities.cpp.

◆ getReactionsAsync()

CoRoutine< UserVector > DiscordCoreAPI::Reactions::getReactionsAsync ( GetReactionsData  dataPackage)
static

Get a list of users that reacted with this emoji. Returns an array of user objects on success.

Parameters
dataPackageA GetReactionsData structure.
Returns
A CoRoutine containing a UserVector.

Definition at line 147 of file ReactionEntities.cpp.

◆ modifyGuildEmojiAsync()

CoRoutine< EmojiData > DiscordCoreAPI::Reactions::modifyGuildEmojiAsync ( ModifyGuildEmojiData  dataPackage)
static

Modifies a single Guild Emoji within a chosen Guild.

Parameters
dataPackageA ModifyGuildEmojiData structure.
Returns
A CoRoutine containing an EmojiData.

Definition at line 244 of file ReactionEntities.cpp.


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