discord_core_api::users Class Reference

An interface class for the user_data related discord endpoints. More...

#include <UserEntities.hpp>

Static Public Member Functions
static co_routine< void >	addRecipientToGroupDMAsync (const add_recipient_to_group_dmdata dataPackage)
	Adds a chosen recipient to a group dm. More...
static user_cache_data	getCachedUser (const get_user_data dataPackage)
	Collects a given user from the library's cache. More...
static co_routine< application_data >	getCurrentUserApplicationInfoAsync ()
	Collects the application responseData associated with the current bot. More...
static co_routine< user_data >	getCurrentUserAsync ()
	Collects the bot's current user_data responseData. More...
static co_routine< authorization_info_data >	getCurrentUserAuthorizationInfoAsync ()
	Collects the authorization info associated with the current bot. More...
static co_routine< user_data >	getUserAsync (const get_user_data dataPackage)
	Collects a given user from the discord servers. More...
static co_routine< jsonifier::vector< connection_data > >	getUserConnectionsAsync ()
	Collects the user_data's connections. More...
static co_routine< user_data >	modifyCurrentUserAsync (const modify_current_user_data dataPackage)
	Modifies the bot's user_data responseData. More...
static co_routine< void >	modifyCurrentUserVoiceStateAsync (const modify_current_user_voice_state_data dataPackage)
	Sets the bot's current voice state. More...
static co_routine< void >	modifyUserVoiceStateAsync (const modify_user_voice_state_data dataPackage)
	Sets another user's current voice state. More...
static co_routine< void >	removeRecipientFromGroupDMAsync (const remove_recipient_from_group_dmdata dataPackage)
	Removes a chosen recipient from a group dm. More...

Member Function Documentation

addRecipientToGroupDMAsync()

co_routine< void > discord_core_api::users::addRecipientToGroupDMAsync ( const add_recipient_to_group_dmdata  dataPackage )

static

Parameters

dataPackage

an add_recipient_to_group_dmdata structure.

Returns

A co_routine containing void.

Definition at line 274 of file UserEntities.cpp.

getCachedUser()

user_cache_data discord_core_api::users::getCachedUser ( const get_user_data  dataPackage )

static

Parameters

dataPackage

a get_user_data structure.

Returns

A co_routine containing a user.

Definition at line 328 of file UserEntities.cpp.

getCurrentUserApplicationInfoAsync()

co_routine< application_data > discord_core_api::users::getCurrentUserApplicationInfoAsync ( )

static

Returns

A co_routine containing an application_data.

Definition at line 376 of file UserEntities.cpp.

getCurrentUserAsync()

co_routine< user_data > discord_core_api::users::getCurrentUserAsync ( )

static

Returns

A co_routine containing a user.

Definition at line 315 of file UserEntities.cpp.

getCurrentUserAuthorizationInfoAsync()

co_routine< authorization_info_data > discord_core_api::users::getCurrentUserAuthorizationInfoAsync ( )

static

Returns

A co_routine containing an authorization_info_data.

Definition at line 387 of file UserEntities.cpp.

getUserAsync()

co_routine< user_data > discord_core_api::users::getUserAsync ( const get_user_data  dataPackage )

static

Parameters

dataPackage

a get_user_data structure.

Returns

A co_routine containing a user.

Definition at line 336 of file UserEntities.cpp.

getUserConnectionsAsync()

co_routine< jsonifier::vector< connection_data > > discord_core_api::users::getUserConnectionsAsync ( )

static

Returns

A co_routine containing a vector<connection_data>.

Definition at line 365 of file UserEntities.cpp.

modifyCurrentUserAsync()

co_routine< user_data > discord_core_api::users::modifyCurrentUserAsync ( const modify_current_user_data  dataPackage )

static

Parameters

dataPackage

a modify_current_user_data structure.

Returns

A co_routine containing a user.

Definition at line 353 of file UserEntities.cpp.

modifyCurrentUserVoiceStateAsync()

co_routine< void > discord_core_api::users::modifyCurrentUserVoiceStateAsync ( const modify_current_user_voice_state_data  dataPackage )

static

Parameters

dataPackage

a modify_current_user_voice_state_data structure.

Returns

A co_routine containing void.

Definition at line 295 of file UserEntities.cpp.

modifyUserVoiceStateAsync()

co_routine< void > discord_core_api::users::modifyUserVoiceStateAsync ( const modify_user_voice_state_data  dataPackage )

static

Parameters

dataPackage

a modify_user_voice_state_data structure.

Returns

A co_routine containing void.

Definition at line 305 of file UserEntities.cpp.

removeRecipientFromGroupDMAsync()

co_routine< void > discord_core_api::users::removeRecipientFromGroupDMAsync ( const remove_recipient_from_group_dmdata  dataPackage )

static

Parameters

dataPackage

a remove_recipient_from_group_dmdata structure.

Returns

A co_routine containing void.

Definition at line 285 of file UserEntities.cpp.

---

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

• UserEntities.hpp
• UserEntities.cpp