DiscordCoreAPI::Channels Class Reference

An interface class for the Channel-related endpoints. More...

#include <ChannelEntities.hpp>

Static Public Member Functions
static CoRoutine< InviteData >	createChannelInviteAsync (CreateChannelInviteData dataPackage)
	Creates an invite to a selected Channel.
static CoRoutine< Channel >	createDMChannelAsync (CreateDMChannelData dataPackage)
	Collect a direct-Message Channel between the bot and the User.
static CoRoutine< Channel >	createGuildChannelAsync (CreateGuildChannelData dataPackage)
	Creates a new Channel within a chosen Guild.
static CoRoutine< void >	deleteChannelPermissionOverwritesAsync (DeleteChannelPermissionOverwritesData dataPackage)
	Delete the given Permissions overwrites for a given User or Role.
static CoRoutine< void >	deleteOrCloseChannelAsync (DeleteOrCloseChannelData dataPackage)
	Delete a Channel, or close a private message.
static CoRoutine< void >	editChannelPermissionOverwritesAsync (EditChannelPermissionOverwritesData dataPackage)
	Edit the given Permissions overwrites for a given User or Role.
static CoRoutine< Channel >	followNewsChannelAsync (FollowNewsChannelData dataPackage)
	Follows a given new Channel with another Channel.
static ChannelData	getCachedChannel (GetChannelData dataPackage)
	Collects a Channel from the library's cache.
static CoRoutine< Channel >	getChannelAsync (GetChannelData dataPackage)
	Collects a Channel from the Discord servers.
static CoRoutine< std::vector< InviteData > >	getChannelInvitesAsync (GetChannelInvitesData dataPackage)
	Collects a vector of the invites to a given Channel.
static CoRoutine< std::vector< Channel > >	getGuildChannelsAsync (GetGuildChannelsData dataPackage)
	Collects a list of Channels from a chosen Guild.
static CoRoutine< std::vector< VoiceRegionData > >	getVoiceRegionsAsync ()
	Collect a list of voice regions that are usable for the RTC-Region option of a given Channel.
static CoRoutine< Channel >	modifyChannelAsync (ModifyChannelData dataPackage)
	Modifies a Channel's properties.
static CoRoutine< void >	modifyGuildChannelPositionsAsync (ModifyGuildChannelPositionsData dataPackage)
	Re-orders the Channel positions, within a chosen Guild.
static CoRoutine< void >	triggerTypingIndicatorAsync (TriggerTypingIndicatorData dataPackage)
	Triggers the typing indicator for the bot in the given Channel.

Member Function Documentation

createChannelInviteAsync()

CoRoutine< InviteData > DiscordCoreAPI::Channels::createChannelInviteAsync ( CreateChannelInviteData  dataPackage )

static

Parameters

dataPackage

A CreateChannelInviteData structure.

Returns

A CoRoutine containing an InviteData.

Definition at line 386 of file ChannelEntities.cpp.

createDMChannelAsync()

CoRoutine< Channel > DiscordCoreAPI::Channels::createDMChannelAsync ( CreateDMChannelData  dataPackage )

static

Parameters

dataPackage

A CreateDMChannelData structure.

Returns

A CoRoutine containing a Channel.

Definition at line 477 of file ChannelEntities.cpp.

createGuildChannelAsync()

CoRoutine< Channel > DiscordCoreAPI::Channels::createGuildChannelAsync ( CreateGuildChannelData  dataPackage )

static

Parameters

dataPackage

A CreateGuildChannelData structure.

Returns

A CoRoutine containing a Channel.

Definition at line 446 of file ChannelEntities.cpp.

deleteChannelPermissionOverwritesAsync()

CoRoutine< void > DiscordCoreAPI::Channels::deleteChannelPermissionOverwritesAsync ( DeleteChannelPermissionOverwritesData  dataPackage )

static

Parameters

dataPackage

A DeleteChannelPermissionOverwritesData structure

Returns

A CoRoutine containing void.

Definition at line 402 of file ChannelEntities.cpp.

deleteOrCloseChannelAsync()

CoRoutine< void > DiscordCoreAPI::Channels::deleteOrCloseChannelAsync ( DeleteOrCloseChannelData  dataPackage )

static

Parameters

dataPackage

A DeleteOrCloseChannelData structure.

Returns

A CoRoutine containing a Channel.

Definition at line 349 of file ChannelEntities.cpp.

editChannelPermissionOverwritesAsync()

CoRoutine< void > DiscordCoreAPI::Channels::editChannelPermissionOverwritesAsync ( EditChannelPermissionOverwritesData  dataPackage )

static

Parameters

dataPackage

An EditChannelPermissionOverwritesData structure.

Returns

A CoRoutine containing void.

Definition at line 361 of file ChannelEntities.cpp.

followNewsChannelAsync()

CoRoutine< Channel > DiscordCoreAPI::Channels::followNewsChannelAsync ( FollowNewsChannelData  dataPackage )

static

Parameters

dataPackage

A FollowNewsChannelData structure.

Returns

A CoRoutine containing a Channel.

Definition at line 414 of file ChannelEntities.cpp.

getCachedChannel()

ChannelData DiscordCoreAPI::Channels::getCachedChannel ( GetChannelData  dataPackage )

static

Parameters

dataPackage

A GetChannelData structure.

Returns

A CoRoutine containing a Channel.

Definition at line 316 of file ChannelEntities.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getChannelAsync()

CoRoutine< Channel > DiscordCoreAPI::Channels::getChannelAsync ( GetChannelData  dataPackage )

static

Parameters

dataPackage

A GetChannelData structure.

Returns

A CoRoutine containing a Channel.

Definition at line 300 of file ChannelEntities.cpp.

Here is the caller graph for this function:

getChannelInvitesAsync()

CoRoutine< std::vector< InviteData > > DiscordCoreAPI::Channels::getChannelInvitesAsync ( GetChannelInvitesData  dataPackage )

static

Parameters

dataPackage

A GetChannelInvitesData structure.

Returns

A CoRoutine containing a InviteDataVector.

Definition at line 376 of file ChannelEntities.cpp.

getGuildChannelsAsync()

CoRoutine< std::vector< Channel > > DiscordCoreAPI::Channels::getGuildChannelsAsync ( GetGuildChannelsData  dataPackage )

static

Parameters

dataPackage

A GetGuildChannelsData structure.

Returns

A CoRoutine containing a ChannelVector.

Definition at line 436 of file ChannelEntities.cpp.

getVoiceRegionsAsync()

CoRoutine< std::vector< VoiceRegionData > > DiscordCoreAPI::Channels::getVoiceRegionsAsync ( )

static

Returns

A CoRoutine containing a VoiceRegionDataVector.

Definition at line 491 of file ChannelEntities.cpp.

modifyChannelAsync()

CoRoutine< Channel > DiscordCoreAPI::Channels::modifyChannelAsync ( ModifyChannelData  dataPackage )

static

Parameters

dataPackage

A ModifyChannelData structure.

Returns

A CoRoutine containing a Channel.

Definition at line 327 of file ChannelEntities.cpp.

modifyGuildChannelPositionsAsync()

CoRoutine< void > DiscordCoreAPI::Channels::modifyGuildChannelPositionsAsync ( ModifyGuildChannelPositionsData  dataPackage )

static

Parameters

dataPackage

A ModifyGuildChannelPositionsData structure.

Returns

A CoRoutine containing void.

Definition at line 462 of file ChannelEntities.cpp.

triggerTypingIndicatorAsync()

CoRoutine< void > DiscordCoreAPI::Channels::triggerTypingIndicatorAsync ( TriggerTypingIndicatorData  dataPackage )

static

Parameters

dataPackage

A TriggerTypingIndicatorData structure.

Returns

A CoRoutine containing void.

Definition at line 427 of file ChannelEntities.cpp.

---

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

• ChannelEntities.hpp
• ChannelEntities.cpp