discord_core_api::channels Class Reference

An interface class for the channel_data related endpoints. More...

#include <ChannelEntities.hpp>

Static Public Member Functions
static co_routine< invite_data >	createChannelInviteAsync (const create_channel_invite_data dataPackage)
	Creates an invite to a selected channel_data. More...
static co_routine< channel_data >	createDMChannelAsync (const create_dmchannel_data dataPackage)
	Collect a direct-message_data channel between the bot and the user_data. More...
static co_routine< channel_data >	createGuildChannelAsync (const create_guild_channel_data dataPackage)
	Creates a new channel_data within a chosen guild_data. More...
static co_routine< void >	deleteChannelPermissionOverwritesAsync (const delete_channel_permission_overwrites_data dataPackage)
	Delete the given jsonifier::string overwrites for a given user or role_data. More...
static co_routine< void >	deleteOrCloseChannelAsync (const delete_or_close_channel_data dataPackage)
	Delete a channel, or close a protected message. More...
static co_routine< void >	editChannelPermissionOverwritesAsync (const edit_channel_permission_overwrites_data dataPackage)
	Edit the given jsonifier::string overwrites for a given user or role_data. More...
static co_routine< channel_data >	followNewsChannelAsync (const follow_news_channel_data dataPackage)
	Follows a given new channel_data with another channel_data. More...
static channel_cache_data	getCachedChannel (const get_channel_data dataPackage)
	Collects a channel from the library's cache. More...
static co_routine< channel_data >	getChannelAsync (const get_channel_data dataPackage)
	Collects a channel from the discord servers. More...
static co_routine< jsonifier::vector< invite_data > >	getChannelInvitesAsync (const get_channel_invites_data dataPackage)
	Collects a vector of the invites to a given channel. More...
static co_routine< jsonifier::vector< channel_data > >	getGuildChannelsAsync (const get_guild_channels_data dataPackage)
	Collects a list of channels from a chosen guild_data. More...
static co_routine< jsonifier::vector< voice_region_data > >	getVoiceRegionsAsync ()
	Collect a list of voice regions that are usable for the rtc-region option of a given channel. More...
static co_routine< channel_data >	modifyChannelAsync (const modify_channel_data dataPackage)
	Modifies a channel's properties. More...
static co_routine< void >	modifyGuildChannelPositionsAsync (const modify_guild_channel_positions_data dataPackage)
	Re-orders the channel_data positions, within a chosen guild_data. More...
static co_routine< void >	triggerTypingIndicatorAsync (const trigger_typing_indicator_data dataPackage)
	Triggers the typing indicator for the bot in the given channel. More...

Member Function Documentation

createChannelInviteAsync()

co_routine< invite_data > discord_core_api::channels::createChannelInviteAsync ( const create_channel_invite_data  dataPackage )

static

Parameters

dataPackage

a create_channel_invite_data structure.

Returns

a co_routine containing an invite_data.

Definition at line 307 of file ChannelEntities.cpp.

createDMChannelAsync()

co_routine< channel_data > discord_core_api::channels::createDMChannelAsync ( const create_dmchannel_data  dataPackage )

static

Parameters

dataPackage

a create_dmchannel_data structure.

Returns

a co_routine containing a channel.

Definition at line 397 of file ChannelEntities.cpp.

createGuildChannelAsync()

co_routine< channel_data > discord_core_api::channels::createGuildChannelAsync ( const create_guild_channel_data  dataPackage )

static

Parameters

dataPackage

a create_guild_channel_data structure.

Returns

a co_routine containing a channel.

Definition at line 368 of file ChannelEntities.cpp.

deleteChannelPermissionOverwritesAsync()

co_routine< void > discord_core_api::channels::deleteChannelPermissionOverwritesAsync ( const delete_channel_permission_overwrites_data  dataPackage )

static

Parameters

dataPackage

a delete_channel_permission_overwrites_data structure

Returns

a co_routine containing void.

Definition at line 322 of file ChannelEntities.cpp.

deleteOrCloseChannelAsync()

co_routine< void > discord_core_api::channels::deleteOrCloseChannelAsync ( const delete_or_close_channel_data  dataPackage )

static

Parameters

dataPackage

a delete_or_close_channel_data structure.

Returns

a co_routine containing a channel.

Definition at line 269 of file ChannelEntities.cpp.

editChannelPermissionOverwritesAsync()

co_routine< void > discord_core_api::channels::editChannelPermissionOverwritesAsync ( const edit_channel_permission_overwrites_data  dataPackage )

static

Parameters

dataPackage

an edit_channel_permission_overwrites_data structure.

Returns

a co_routine containing void.

Definition at line 282 of file ChannelEntities.cpp.

followNewsChannelAsync()

co_routine< channel_data > discord_core_api::channels::followNewsChannelAsync ( const follow_news_channel_data  dataPackage )

static

Parameters

dataPackage

a follow_news_channel_data structure.

Returns

a co_routine containing a channel.

Definition at line 335 of file ChannelEntities.cpp.

getCachedChannel()

channel_cache_data discord_core_api::channels::getCachedChannel ( const get_channel_data  dataPackage )

static

Parameters

dataPackage

a get_channel_data structure.

Returns

a co_routine containing a channel.

Definition at line 240 of file ChannelEntities.cpp.

Here is the call graph for this function:

getChannelAsync()

co_routine< channel_data > discord_core_api::channels::getChannelAsync ( const get_channel_data  dataPackage )

static

Parameters

dataPackage

a get_channel_data structure.

Returns

a co_routine containing a channel.

Definition at line 223 of file ChannelEntities.cpp.

Here is the caller graph for this function:

getChannelInvitesAsync()

co_routine< jsonifier::vector< invite_data > > discord_core_api::channels::getChannelInvitesAsync ( const get_channel_invites_data  dataPackage )

static

Parameters

dataPackage

a get_channel_invites_data structure.

Returns

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

Definition at line 296 of file ChannelEntities.cpp.

getGuildChannelsAsync()

co_routine< jsonifier::vector< channel_data > > discord_core_api::channels::getGuildChannelsAsync ( const get_guild_channels_data  dataPackage )

static

Parameters

dataPackage

a get_guild_channels_data structure.

Returns

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

Definition at line 357 of file ChannelEntities.cpp.

getVoiceRegionsAsync()

co_routine< jsonifier::vector< voice_region_data > > discord_core_api::channels::getVoiceRegionsAsync ( )

static

Returns

a co_routine containing a voice_region_data_vector.

Definition at line 409 of file ChannelEntities.cpp.

modifyChannelAsync()

co_routine< channel_data > discord_core_api::channels::modifyChannelAsync ( const modify_channel_data  dataPackage )

static

Parameters

dataPackage

a modify_channel_data structure.

Returns

a co_routine containing a channel.

Definition at line 248 of file ChannelEntities.cpp.

modifyGuildChannelPositionsAsync()

co_routine< void > discord_core_api::channels::modifyGuildChannelPositionsAsync ( const modify_guild_channel_positions_data  dataPackage )

static

Parameters

dataPackage

a modify_guild_channel_positions_data structure.

Returns

a co_routine containing void.

Definition at line 383 of file ChannelEntities.cpp.

triggerTypingIndicatorAsync()

co_routine< void > discord_core_api::channels::triggerTypingIndicatorAsync ( const trigger_typing_indicator_data  dataPackage )

static

Parameters

dataPackage

a trigger_typing_indicator_data structure.

Returns

a co_routine containing void.

Definition at line 347 of file ChannelEntities.cpp.

---

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

• ChannelEntities.hpp
• ChannelEntities.cpp