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.
static UserData	getCachedUser (GetUserData dataPackage)
	Collects a given User from the library's cache.
static CoRoutine< ApplicationData >	getCurrentUserApplicationInfoAsync ()
	Collects the Application responseData associated with the current Bot.
static CoRoutine< User >	getCurrentUserAsync ()
	Collects the Bot's current User responseData.
static CoRoutine< AuthorizationInfoData >	getCurrentUserAuthorizationInfoAsync ()
	Collects the Authorization info associated with the current Bot.
static CoRoutine< User >	getUserAsync (GetUserData dataPackage)
	Collects a given User from the Discord servers.
static CoRoutine< std::vector< ConnectionData > >	getUserConnectionsAsync ()
	Collects the User's Connections.
static CoRoutine< User >	modifyCurrentUserAsync (ModifyCurrentUserData dataPackage)
	Modifies the Bot's User responseData.
static CoRoutine< void >	modifyCurrentUserVoiceStateAsync (ModifyCurrentUserVoiceStateData dataPackage)
	Sets the bot's current voice state.
static CoRoutine< void >	modifyUserVoiceStateAsync (ModifyUserVoiceStateData dataPackage)
	Sets another user's current voice state.
static CoRoutine< void >	removeRecipientFromGroupDMAsync (RemoveRecipientFromGroupDMData dataPackage)
	Removes a chosen recipient from a group DM.

Member Function Documentation

addRecipientToGroupDMAsync()

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

static

Parameters

dataPackage

An AddRecipientToGroupDMData structure.

Returns

A CoRoutine containing void.

Definition at line 166 of file UserEntities.cpp.

getCachedUser()

UserData DiscordCoreAPI::Users::getCachedUser ( GetUserData  dataPackage )

static

Parameters

dataPackage

A GetUserData structure.

Returns

A CoRoutine containing a User.

Definition at line 217 of file UserEntities.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentUserApplicationInfoAsync()

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

static

Returns

A CoRoutine containing an ApplicationData.

Definition at line 277 of file UserEntities.cpp.

getCurrentUserAsync()

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

static

Returns

A CoRoutine containing a User.

Definition at line 205 of file UserEntities.cpp.

getCurrentUserAuthorizationInfoAsync()

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

static

Returns

A CoRoutine containing an AuthorizationInfoData.

Definition at line 287 of file UserEntities.cpp.

getUserAsync()

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

static

Parameters

dataPackage

A GetUserData structure.

Returns

A CoRoutine containing a User.

Definition at line 229 of file UserEntities.cpp.

Here is the caller graph for this function:

getUserConnectionsAsync()

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

static

Returns

A CoRoutine containing a vector<ConnectionData>.

Definition at line 267 of file UserEntities.cpp.

modifyCurrentUserAsync()

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

static

Parameters

dataPackage

A ModifyCurrentUserData structure.

Returns

A CoRoutine containing a User.

Definition at line 245 of file UserEntities.cpp.

modifyCurrentUserVoiceStateAsync()

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

static

Parameters

dataPackage

A ModifyCurrentUserVoiceStateData structure.

Returns

A CoRoutine containing void.

Definition at line 187 of file UserEntities.cpp.

modifyUserVoiceStateAsync()

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

static

Parameters

dataPackage

A ModifyUserVoiceStateData structure.

Returns

A CoRoutine containing void.

Definition at line 196 of file UserEntities.cpp.

removeRecipientFromGroupDMAsync()

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

static

Parameters

dataPackage

A RemoveRecipientFromGroupDMData structure.

Returns

A CoRoutine containing void.

Definition at line 178 of file UserEntities.cpp.

---

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

• UserEntities.hpp
• UserEntities.cpp