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

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

#include <UserEntities.hpp>

Static Public Member Functions

static CoRoutine< void > addRecipientToGroupDMAsync (AddRecipientToGroupDMData dataPackage)
 Adds a chosen recipient to a group Dm. More...
 
static CoRoutine< UserDatagetCachedUserAsync (GetUserData dataPackage)
 Collects a given User from the library's cache. More...
 
static CoRoutine< ApplicationDatagetCurrentUserApplicationInfoAsync ()
 Collects the Application responseData associated with the current Bot. More...
 
static CoRoutine< UsergetCurrentUserAsync ()
 Collects the Bot's current User responseData. More...
 
static CoRoutine< AuthorizationInfoDatagetCurrentUserAuthorizationInfoAsync ()
 Collects the Authorization info associated with the current Bot. More...
 
static CoRoutine< UsergetUserAsync (GetUserData dataPackage)
 Collects a given User from the Discord servers. More...
 
static CoRoutine< std::vector< ConnectionData > > getUserConnectionsAsync ()
 Collects the User's Connections. More...
 
static CoRoutine< UsermodifyCurrentUserAsync (ModifyCurrentUserData dataPackage)
 Modifies the Bot's User responseData. More...
 
static CoRoutine< void > modifyCurrentUserVoiceStateAsync (ModifyCurrentUserVoiceStateData dataPackage)
 Sets the bot's current voice state. More...
 
static CoRoutine< void > modifyUserVoiceStateAsync (ModifyUserVoiceStateData dataPackage)
 Sets another user's current voice state. More...
 
static CoRoutine< void > removeRecipientFromGroupDMAsync (RemoveRecipientFromGroupDMData dataPackage)
 Removes a chosen recipient from a group Dm. More...
 

Member Function Documentation

◆ addRecipientToGroupDMAsync()

CoRoutine< void > DiscordCoreAPI::Users::addRecipientToGroupDMAsync ( AddRecipientToGroupDMData  dataPackage)
static

Adds a chosen recipient to a group Dm.

Parameters
dataPackageAn AddRecipientToGroupDMData structure.
Returns
A CoRoutine containing void.

Definition at line 152 of file UserEntities.cpp.

◆ getCachedUserAsync()

CoRoutine< UserData > DiscordCoreAPI::Users::getCachedUserAsync ( GetUserData  dataPackage)
static

Collects a given User from the library's cache.

Parameters
dataPackageA GetUserData structure.
Returns
A CoRoutine containing a User.

Definition at line 200 of file UserEntities.cpp.

Here is the call graph for this function:

◆ getCurrentUserApplicationInfoAsync()

CoRoutine< ApplicationData > DiscordCoreAPI::Users::getCurrentUserApplicationInfoAsync ( )
static

Collects the Application responseData associated with the current Bot.

Returns
A CoRoutine containing an ApplicationData.

Definition at line 257 of file UserEntities.cpp.

◆ getCurrentUserAsync()

CoRoutine< User > DiscordCoreAPI::Users::getCurrentUserAsync ( )
static

Collects the Bot's current User responseData.

Returns
A CoRoutine containing a User.

Definition at line 189 of file UserEntities.cpp.

◆ getCurrentUserAuthorizationInfoAsync()

CoRoutine< AuthorizationInfoData > DiscordCoreAPI::Users::getCurrentUserAuthorizationInfoAsync ( )
static

Collects the Authorization info associated with the current Bot.

Returns
A CoRoutine containing an AuthorizationInfoData.

Definition at line 266 of file UserEntities.cpp.

◆ getUserAsync()

CoRoutine< User > DiscordCoreAPI::Users::getUserAsync ( GetUserData  dataPackage)
static

Collects a given User from the Discord servers.

Parameters
dataPackageA GetUserData structure.
Returns
A CoRoutine containing a User.

Definition at line 212 of file UserEntities.cpp.

Here is the caller graph for this function:

◆ getUserConnectionsAsync()

CoRoutine< std::vector< ConnectionData > > DiscordCoreAPI::Users::getUserConnectionsAsync ( )
static

Collects the User's Connections.

Returns
A CoRoutine containing a vector<ConnectionData>.

Definition at line 248 of file UserEntities.cpp.

◆ modifyCurrentUserAsync()

CoRoutine< User > DiscordCoreAPI::Users::modifyCurrentUserAsync ( ModifyCurrentUserData  dataPackage)
static

Modifies the Bot's User responseData.

Parameters
dataPackageA ModifyCurrentUserData structure.
Returns
A CoRoutine containing a User.

Definition at line 229 of file UserEntities.cpp.

◆ modifyCurrentUserVoiceStateAsync()

CoRoutine< void > DiscordCoreAPI::Users::modifyCurrentUserVoiceStateAsync ( ModifyCurrentUserVoiceStateData  dataPackage)
static

Sets the bot's current voice state.

Parameters
dataPackageA ModifyCurrentUserVoiceStateData structure.
Returns
A CoRoutine containing void.

Definition at line 171 of file UserEntities.cpp.

◆ modifyUserVoiceStateAsync()

CoRoutine< void > DiscordCoreAPI::Users::modifyUserVoiceStateAsync ( ModifyUserVoiceStateData  dataPackage)
static

Sets another user's current voice state.

Parameters
dataPackageA ModifyUserVoiceStateData structure.
Returns
A CoRoutine containing void.

Definition at line 180 of file UserEntities.cpp.

◆ removeRecipientFromGroupDMAsync()

CoRoutine< void > DiscordCoreAPI::Users::removeRecipientFromGroupDMAsync ( RemoveRecipientFromGroupDMData  dataPackage)
static

Removes a chosen recipient from a group Dm.

Parameters
dataPackageA RemoveRecipientFromGroupDMData structure.
Returns
A CoRoutine containing void.

Definition at line 162 of file UserEntities.cpp.


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