DiscordCoreAPI::GuildMembers Class Reference

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

#include <GuildMemberEntities.hpp>

Static Public Member Functions
static CoRoutine< GuildMember >	addGuildMemberAsync (AddGuildMemberData dataPackage)
	Adds a GuildMember to a chosen Guild.
static GuildMemberData	getCachedGuildMember (GetGuildMemberData dataPackage)
	Collects a GuildMember from the library's cache.
static CoRoutine< GuildMember >	getGuildMemberAsync (GetGuildMemberData dataPackage)
	Collects a GuildMember from the Discord servers.
static CoRoutine< std::vector< GuildMember > >	listGuildMembersAsync (ListGuildMembersData dataPackage)
	Lists all of the GuildMembers of a chosen Guild.
static CoRoutine< GuildMember >	modifyCurrentGuildMemberAsync (ModifyCurrentGuildMemberData dataPackage)
	Modifies the current GuildMember's properties.
static CoRoutine< GuildMember >	modifyGuildMemberAsync (ModifyGuildMemberData dataPackage)
	Modifies a GuildMember's properties.
static CoRoutine< void >	removeGuildMemberAsync (RemoveGuildMemberData dataPackage)
	Removes a chosen GuildMember from a chosen Guild.
static CoRoutine< std::vector< GuildMember > >	searchGuildMembersAsync (SearchGuildMembersData dataPackage)
	Searches for a list of GuildMembers of a chosen Guild.
static CoRoutine< GuildMember >	timeoutGuildMemberAsync (TimeoutGuildMemberData dataPackage)
	Times-out a chosen GuildMember from a chosen Guild.

Member Function Documentation

addGuildMemberAsync()

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

static

Parameters

dataPackage

An AddGuildMemberData structure.

Returns

A CoRoutine containing a vector<GuildMembers>.

Definition at line 223 of file GuildMemberEntities.cpp.

getCachedGuildMember()

GuildMemberData DiscordCoreAPI::GuildMembers::getCachedGuildMember ( GetGuildMemberData  dataPackage )

static

Parameters

dataPackage

A GetGuildMemberData structure.

Returns

A CoRoutine containing a GuildMember.

Definition at line 177 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

Parameters

dataPackage

A GetGuildMemberData structure.

Returns

A CoRoutine containing a GuildMember.

Definition at line 158 of file GuildMemberEntities.cpp.

Here is the caller graph for this function:

listGuildMembersAsync()

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

static

Parameters

dataPackage

A ListGuildMembersData structure.

Returns

A CoRoutine containing a vector<GuildMembers>.

Definition at line 187 of file GuildMemberEntities.cpp.

modifyCurrentGuildMemberAsync()

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

static

Parameters

dataPackage

A ModifyCurrentGuildMemberData structure.

Returns

A CoRoutine containing a GuildMember.

Definition at line 236 of file GuildMemberEntities.cpp.

modifyGuildMemberAsync()

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

static

Parameters

dataPackage

A ModifyGuildMemberData structure.

Returns

A CoRoutine containing a GuildMember.

Definition at line 253 of file GuildMemberEntities.cpp.

Here is the caller graph for this function:

removeGuildMemberAsync()

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

static

Parameters

dataPackage

A RemoveGuildMemberData structure.

Returns

A CoRoutine containing void.

Definition at line 278 of file GuildMemberEntities.cpp.

Here is the call graph for this function:

searchGuildMembersAsync()

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

static

Parameters

dataPackage

A SearchGuildMembersData structure.

Returns

A CoRoutine containing a vector<GuildMembers>.

Definition at line 205 of file GuildMemberEntities.cpp.

timeoutGuildMemberAsync()

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

static

Parameters

dataPackage

A TimeoutGuildMemberData structure.

Returns

A CoRoutine containing GuildMember.

Definition at line 292 of file GuildMemberEntities.cpp.

Here is the call graph for this function:

---

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

• GuildMemberEntities.hpp
• GuildMemberEntities.cpp