discord_core_api::roles Class Reference

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

#include <RoleEntities.hpp>

Static Public Member Functions
static co_routine< void >	addGuildMemberRoleAsync (const add_guild_member_role_data dataPackage)
	Adds a role_data to a chosen guild member. More...
static co_routine< role_data >	createGuildRoleAsync (const create_guild_role_data dataPackage)
	Creates a new role_data within the given guild. More...
static role_cache_data	getCachedRole (const get_role_data dataPackage)
	Collects a given role from the library's cache. More...
static co_routine< jsonifier::vector< role_data > >	getGuildMemberRolesAsync (const get_guild_member_roles_data dataPackage)
	Collects the roles that a guild_member has. More...
static co_routine< jsonifier::vector< role_data > >	getGuildRolesAsync (const get_guild_roles_data dataPackage)
	Collects the roles that a guild has. More...
static co_routine< role_data >	getRoleAsync (const get_role_data dataPackage)
	Collects a role_data from the discord servers. More...
static co_routine< role_data >	modifyGuildRoleAsync (const modify_guild_role_data dataPackage)
	Updates a given role's properties. More...
static co_routine< jsonifier::vector< role_data > >	modifyGuildRolePositionsAsync (modify_guild_role_positions_data dataPackage)
	Updates a role_data's positions. More...
static co_routine< void >	removeGuildMemberRoleAsync (const remove_guild_member_role_data dataPackage)
	Removes a given role from a chosen guild_member_data. More...
static co_routine< void >	removeGuildRoleAsync (const remove_guild_role_data dataPackage)
	Removes a given role from a guild. More...

Member Function Documentation

addGuildMemberRoleAsync()

co_routine< void > discord_core_api::roles::addGuildMemberRoleAsync ( const add_guild_member_role_data  dataPackage )

static

Parameters

dataPackage

an add_guild_member_role_data structure.

Returns

a co_routine containing void.

Definition at line 149 of file RoleEntities.cpp.

createGuildRoleAsync()

co_routine< role_data > discord_core_api::roles::createGuildRoleAsync ( const create_guild_role_data  dataPackage )

static

Parameters

dataPackage

a create_guild_role_data structure.

Returns

a co_routine containing a role_data.

Definition at line 189 of file RoleEntities.cpp.

Here is the call graph for this function:

getCachedRole()

role_cache_data discord_core_api::roles::getCachedRole ( const get_role_data  dataPackage )

static

Parameters

dataPackage

a get_role_data structure.

Returns

a co_routine containing a role_data.

Definition at line 323 of file RoleEntities.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getGuildMemberRolesAsync()

co_routine< jsonifier::vector< role_data > > discord_core_api::roles::getGuildMemberRolesAsync ( const get_guild_member_roles_data  dataPackage )

static

Parameters

dataPackage

a get_guild_member_roles_data structure.

Returns

a co_routine containing a jsonifier::vector<role_data>.

Definition at line 288 of file RoleEntities.cpp.

Here is the call graph for this function:

getGuildRolesAsync()

co_routine< jsonifier::vector< role_data > > discord_core_api::roles::getGuildRolesAsync ( const get_guild_roles_data  dataPackage )

static

Parameters

dataPackage

a get_guild_roles_data structure.

Returns

a co_routine containing a jsonifier::vector<role_data>.

Definition at line 175 of file RoleEntities.cpp.

Here is the caller graph for this function:

getRoleAsync()

co_routine< role_data > discord_core_api::roles::getRoleAsync ( const get_role_data  dataPackage )

static

Parameters

dataPackage

a get_role_data structure.

Returns

a co_routine containing a role_data.

Definition at line 302 of file RoleEntities.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

modifyGuildRoleAsync()

co_routine< role_data > discord_core_api::roles::modifyGuildRoleAsync ( const modify_guild_role_data  dataPackage )

static

Parameters

dataPackage

a modify_guild_role_data structure.

Returns

a co_routine containing a role_data.

Definition at line 254 of file RoleEntities.cpp.

modifyGuildRolePositionsAsync()

co_routine< jsonifier::vector< role_data > > discord_core_api::roles::modifyGuildRolePositionsAsync ( modify_guild_role_positions_data  dataPackage )

static

Parameters

dataPackage

a modify_guild_role_positions_data structure.

Returns

a co_routine containing a jsonifier::vector<role_data>.

Definition at line 214 of file RoleEntities.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

removeGuildMemberRoleAsync()

co_routine< void > discord_core_api::roles::removeGuildMemberRoleAsync ( const remove_guild_member_role_data  dataPackage )

static

Parameters

dataPackage

a remove_guild_member_role_data structure.

Returns

a co_routine containing void.

Definition at line 162 of file RoleEntities.cpp.

removeGuildRoleAsync()

co_routine< void > discord_core_api::roles::removeGuildRoleAsync ( const remove_guild_role_data  dataPackage )

static

Parameters

dataPackage

a remove_guild_role_data structure.

Returns

a co_routine containing void.

Definition at line 275 of file RoleEntities.cpp.

---

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

• RoleEntities.hpp
• RoleEntities.cpp