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

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

#include <GuildMemberEntities.hpp>

Static Public Member Functions

static CoRoutine< GuildMemberaddGuildMemberAsync (AddGuildMemberData dataPackage)
 Adds a GuildMember to a chosen Guild. More...
 
static CoRoutine< GuildMemberDatagetCachedGuildMemberAsync (GetGuildMemberData dataPackage)
 Collects a GuildMember from the library's cache. More...
 
static CoRoutine< GuildMembergetGuildMemberAsync (GetGuildMemberData dataPackage)
 Collects a GuildMember from the Discord servers. More...
 
static CoRoutine< std::vector< GuildMember > > listGuildMembersAsync (ListGuildMembersData dataPackage)
 Lists all of the GuildMembers of a chosen Guild. More...
 
static CoRoutine< GuildMembermodifyCurrentGuildMemberAsync (ModifyCurrentGuildMemberData dataPackage)
 Modifies the current GuildMember's properties. More...
 
static CoRoutine< GuildMembermodifyGuildMemberAsync (ModifyGuildMemberData dataPackage)
 Modifies a GuildMember's properties. More...
 
static CoRoutine< void > removeGuildMemberAsync (RemoveGuildMemberData dataPackage)
 Removes a chosen GuildMember from a chosen Guild. More...
 
static CoRoutine< std::vector< GuildMember > > searchGuildMembersAsync (SearchGuildMembersData dataPackage)
 Searches for a list of GuildMembers of a chosen Guild. More...
 
static CoRoutine< GuildMembertimeoutGuildMemberAsync (TimeoutGuildMemberData dataPackage)
 Times-out a chosen GuildMember from a chosen Guild. More...
 

Member Function Documentation

◆ addGuildMemberAsync()

CoRoutine< GuildMember > DiscordCoreAPI::GuildMembers::addGuildMemberAsync ( AddGuildMemberData  dataPackage)
static

Adds a GuildMember to a chosen Guild.

Parameters
dataPackageAn AddGuildMemberData structure.
Returns
A CoRoutine containing a vector<GuildMembers>.

Definition at line 227 of file GuildMemberEntities.cpp.

◆ getCachedGuildMemberAsync()

CoRoutine< GuildMemberData > DiscordCoreAPI::GuildMembers::getCachedGuildMemberAsync ( GetGuildMemberData  dataPackage)
static

Collects a GuildMember from the library's cache.

Parameters
dataPackageA GetGuildMemberData structure.
Returns
A CoRoutine containing a GuildMember.

Definition at line 181 of file GuildMemberEntities.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getGuildMemberAsync()

CoRoutine< GuildMember > DiscordCoreAPI::GuildMembers::getGuildMemberAsync ( GetGuildMemberData  dataPackage)
static

Collects a GuildMember from the Discord servers.

Parameters
dataPackageA GetGuildMemberData structure.
Returns
A CoRoutine containing a GuildMember.

Definition at line 163 of file GuildMemberEntities.cpp.

Here is the caller graph for this function:

◆ listGuildMembersAsync()

CoRoutine< std::vector< GuildMember > > DiscordCoreAPI::GuildMembers::listGuildMembersAsync ( ListGuildMembersData  dataPackage)
static

Lists all of the GuildMembers of a chosen Guild.

Parameters
dataPackageA ListGuildMembersData structure.
Returns
A CoRoutine containing a vector<GuildMembers>.

Definition at line 193 of file GuildMemberEntities.cpp.

◆ modifyCurrentGuildMemberAsync()

CoRoutine< GuildMember > DiscordCoreAPI::GuildMembers::modifyCurrentGuildMemberAsync ( ModifyCurrentGuildMemberData  dataPackage)
static

Modifies the current GuildMember's properties.

Parameters
dataPackageA ModifyCurrentGuildMemberData structure.
Returns
A CoRoutine containing a GuildMember.

Definition at line 237 of file GuildMemberEntities.cpp.

◆ modifyGuildMemberAsync()

CoRoutine< GuildMember > DiscordCoreAPI::GuildMembers::modifyGuildMemberAsync ( ModifyGuildMemberData  dataPackage)
static

Modifies a GuildMember's properties.

Parameters
dataPackageA ModifyGuildMemberData structure.
Returns
A CoRoutine containing a GuildMember.

Definition at line 252 of file GuildMemberEntities.cpp.

Here is the caller graph for this function:

◆ removeGuildMemberAsync()

CoRoutine< void > DiscordCoreAPI::GuildMembers::removeGuildMemberAsync ( RemoveGuildMemberData  dataPackage)
static

Removes a chosen GuildMember from a chosen Guild.

Parameters
dataPackageA RemoveGuildMemberData structure.
Returns
A CoRoutine containing void.

Definition at line 274 of file GuildMemberEntities.cpp.

Here is the call graph for this function:

◆ searchGuildMembersAsync()

CoRoutine< std::vector< GuildMember > > DiscordCoreAPI::GuildMembers::searchGuildMembersAsync ( SearchGuildMembersData  dataPackage)
static

Searches for a list of GuildMembers of a chosen Guild.

Parameters
dataPackageA SearchGuildMembersData structure.
Returns
A CoRoutine containing a vector<GuildMembers>.

Definition at line 210 of file GuildMemberEntities.cpp.

◆ timeoutGuildMemberAsync()

CoRoutine< GuildMember > DiscordCoreAPI::GuildMembers::timeoutGuildMemberAsync ( TimeoutGuildMemberData  dataPackage)
static

Times-out a chosen GuildMember from a chosen Guild.

Parameters
dataPackageA TimeoutGuildMemberData structure.
Returns
A CoRoutine containing GuildMember.

Definition at line 287 of file GuildMemberEntities.cpp.

Here is the call graph for this function:

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