DiscordCoreAPI::Roles Class Reference

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

#include <RoleEntities.hpp>

Static Public Member Functions
static CoRoutine< void >	addGuildMemberRoleAsync (AddGuildMemberRoleData dataPackage)
	Adds a Role to a chosen Guild member.
static CoRoutine< Role >	createGuildRoleAsync (CreateGuildRoleData dataPackage)
	Creates a new Role within the given Guild.
static RoleData	getCachedRole (GetRoleData dataPackage)
	Collects a given Role from the library's cache.
static CoRoutine< std::vector< Role > >	getGuildMemberRolesAsync (GetGuildMemberRolesData dataPackage)
	Collects the Roles that a GuildMember has.
static CoRoutine< std::vector< Role > >	getGuildRolesAsync (GetGuildRolesData dataPackage)
	Collects the Roles that a Guild has.
static CoRoutine< Role >	getRoleAsync (GetRoleData dataPackage)
	Collects a Role from the Discord servers.
static CoRoutine< Role >	modifyGuildRoleAsync (ModifyGuildRoleData dataPackage)
	Updates a given Role's properties.
static CoRoutine< std::vector< Role > >	modifyGuildRolePositionsAsync (ModifyGuildRolePositionsData dataPackage)
	Updates a Role's positions.
static CoRoutine< void >	removeGuildMemberRoleAsync (RemoveGuildMemberRoleData dataPackage)
	Removes a given Role from a chosen GuildMember.
static CoRoutine< void >	removeGuildRoleAsync (RemoveGuildRoleData dataPackage)
	Removes a given Role from a Guild.

Member Function Documentation

addGuildMemberRoleAsync()

CoRoutine< void > DiscordCoreAPI::Roles::addGuildMemberRoleAsync ( AddGuildMemberRoleData  dataPackage )

static

Parameters

dataPackage

An AddGuildMemberRoleData structure.

Returns

A CoRoutine containing void.

Definition at line 178 of file RoleEntities.cpp.

createGuildRoleAsync()

CoRoutine< Role > DiscordCoreAPI::Roles::createGuildRoleAsync ( CreateGuildRoleData  dataPackage )

static

Parameters

dataPackage

A CreateGuildRoleData structure.

Returns

A CoRoutine containing a Role.

Definition at line 215 of file RoleEntities.cpp.

Here is the call graph for this function:

getCachedRole()

RoleData DiscordCoreAPI::Roles::getCachedRole ( GetRoleData  dataPackage )

static

Parameters

dataPackage

A GetRoleData structure.

Returns

A CoRoutine containing a Role.

Definition at line 346 of file RoleEntities.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getGuildMemberRolesAsync()

CoRoutine< std::vector< Role > > DiscordCoreAPI::Roles::getGuildMemberRolesAsync ( GetGuildMemberRolesData  dataPackage )

static

Parameters

dataPackage

A GetGuildMemberRolesData structure.

Returns

A CoRoutine containing a RoleVector.

Definition at line 317 of file RoleEntities.cpp.

Here is the call graph for this function:

getGuildRolesAsync()

CoRoutine< std::vector< Role > > DiscordCoreAPI::Roles::getGuildRolesAsync ( GetGuildRolesData  dataPackage )

static

Parameters

dataPackage

A GetGuildRolesData structure.

Returns

A CoRoutine containing a RoleVector.

Definition at line 202 of file RoleEntities.cpp.

Here is the caller graph for this function:

getRoleAsync()

CoRoutine< Role > DiscordCoreAPI::Roles::getRoleAsync ( GetRoleData  dataPackage )

static

Parameters

dataPackage

A GetRoleData structure.

Returns

A CoRoutine containing a Role.

Definition at line 331 of file RoleEntities.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

modifyGuildRoleAsync()

CoRoutine< Role > DiscordCoreAPI::Roles::modifyGuildRoleAsync ( ModifyGuildRoleData  dataPackage )

static

Parameters

dataPackage

A ModifyGuildRoleData structure.

Returns

A CoRoutine containing a Role.

Definition at line 283 of file RoleEntities.cpp.

modifyGuildRolePositionsAsync()

CoRoutine< std::vector< Role > > DiscordCoreAPI::Roles::modifyGuildRolePositionsAsync ( ModifyGuildRolePositionsData  dataPackage )

static

Parameters

dataPackage

A ModifyGuildRolePositionsData structure.

Returns

A CoRoutine containing a RoleVector.

Definition at line 242 of file RoleEntities.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

removeGuildMemberRoleAsync()

CoRoutine< void > DiscordCoreAPI::Roles::removeGuildMemberRoleAsync ( RemoveGuildMemberRoleData  dataPackage )

static

Parameters

dataPackage

A RemoveGuildMemberRoleData structure.

Returns

A CoRoutine containing void.

Definition at line 190 of file RoleEntities.cpp.

removeGuildRoleAsync()

CoRoutine< void > DiscordCoreAPI::Roles::removeGuildRoleAsync ( RemoveGuildRoleData  dataPackage )

static

Parameters

dataPackage

A RemoveGuildRoleData structure.

Returns

A CoRoutine containing void.

Definition at line 305 of file RoleEntities.cpp.

---

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

• RoleEntities.hpp
• RoleEntities.cpp