discord_core_api::guild_members Class Reference

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

#include <GuildMemberEntities.hpp>

Static Public Member Functions
static co_routine< guild_member_data >	addGuildMemberAsync (const add_guild_member_data dataPackage)
	Adds a guild_member to a chosen guild. More...
static guild_member_cache_data	getCachedGuildMember (const get_guild_member_data dataPackage)
	Collects a guild_member from the library's cache. More...
static co_routine< guild_member_data >	getGuildMemberAsync (const get_guild_member_data dataPackage)
	Collects a guild_member from the discord servers. More...
static voice_state_data_light	getVoiceStateData (const two_id_key &voiceState)
	Collect a given guild_member's voice state data. More...
static co_routine< jsonifier::vector< guild_member_data > >	listGuildMembersAsync (const list_guild_members_data dataPackage)
	Lists all of the guild_members of a chosen guild. More...
static co_routine< guild_member_data >	modifyCurrentGuildMemberAsync (const modify_current_guild_member_data dataPackage)
	Modifies the current guild_member_data's properties. More...
static co_routine< guild_member_data >	modifyGuildMemberAsync (const modify_guild_member_data dataPackage)
	Modifies a guild_member's properties. More...
static co_routine< void >	removeGuildMemberAsync (const remove_guild_member_data dataPackage)
	Removes a chosen guild_member_data from a chosen guild. More...
static co_routine< jsonifier::vector< guild_member_data > >	searchGuildMembersAsync (const search_guild_members_data dataPackage)
	Searches for a list of guild_members of a chosen guild. More...
static co_routine< guild_member_data >	timeoutGuildMemberAsync (const timeout_guild_member_data dataPackage)
	Times-out a chosen guild_member_data from a chosen guild. More...

Member Function Documentation

addGuildMemberAsync()

co_routine< guild_member_data > discord_core_api::guild_members::addGuildMemberAsync ( const add_guild_member_data  dataPackage )

static

Parameters

dataPackage

an add_guild_member_data structure.

Returns

a co_routine containing a vector<guild_members>.

Definition at line 221 of file GuildMemberEntities.cpp.

getCachedGuildMember()

guild_member_cache_data discord_core_api::guild_members::getCachedGuildMember ( const get_guild_member_data  dataPackage )

static

Parameters

dataPackage

a get_guild_member_data structure.

Returns

a co_routine containing a guild_member.

Definition at line 171 of file GuildMemberEntities.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getGuildMemberAsync()

co_routine< guild_member_data > discord_core_api::guild_members::getGuildMemberAsync ( const get_guild_member_data  dataPackage )

static

Parameters

dataPackage

a get_guild_member_data structure.

Returns

a co_routine containing a guild_member.

Definition at line 151 of file GuildMemberEntities.cpp.

Here is the caller graph for this function:

getVoiceStateData()

voice_state_data_light discord_core_api::guild_members::getVoiceStateData ( const two_id_key &  voiceState )

static

Parameters

voiceState

A two-id-key representing their user-id and guild-id.

Returns

voice_state_data_light The guild_member's voice_state_data.

Definition at line 340 of file GuildMemberEntities.cpp.

listGuildMembersAsync()

co_routine< jsonifier::vector< guild_member_data > > discord_core_api::guild_members::listGuildMembersAsync ( const list_guild_members_data  dataPackage )

static

Parameters

dataPackage

a list_guild_members_data structure.

Returns

a co_routine containing a vector<guild_members>.

Definition at line 183 of file GuildMemberEntities.cpp.

modifyCurrentGuildMemberAsync()

co_routine< guild_member_data > discord_core_api::guild_members::modifyCurrentGuildMemberAsync ( const modify_current_guild_member_data  dataPackage )

static

Parameters

dataPackage

a modify_current_guild_member_data structure.

Returns

a co_routine containing a guild_member.

Definition at line 233 of file GuildMemberEntities.cpp.

modifyGuildMemberAsync()

co_routine< guild_member_data > discord_core_api::guild_members::modifyGuildMemberAsync ( const modify_guild_member_data  dataPackage )

static

Parameters

dataPackage

a modify_guild_member_data structure.

Returns

a co_routine containing a guild_member.

Definition at line 248 of file GuildMemberEntities.cpp.

Here is the caller graph for this function:

removeGuildMemberAsync()

co_routine< void > discord_core_api::guild_members::removeGuildMemberAsync ( const remove_guild_member_data  dataPackage )

static

Parameters

dataPackage

a remove_guild_member_data structure.

Returns

a co_routine containing void.

Definition at line 272 of file GuildMemberEntities.cpp.

searchGuildMembersAsync()

co_routine< jsonifier::vector< guild_member_data > > discord_core_api::guild_members::searchGuildMembersAsync ( const search_guild_members_data  dataPackage )

static

Parameters

dataPackage

a search_guild_members_data structure.

Returns

a co_routine containing a vector<guild_members>.

Definition at line 202 of file GuildMemberEntities.cpp.

timeoutGuildMemberAsync()

co_routine< guild_member_data > discord_core_api::guild_members::timeoutGuildMemberAsync ( const timeout_guild_member_data  dataPackage )

static

Parameters

dataPackage

a timeout_guild_member_data structure.

Returns

a co_routine containing guild_member_data.

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