DiscordCoreAPI
A Discord bot library written in C++, with custom asynchronous coroutines.
Loading...
Searching...
No Matches
DiscordCoreAPI::Channels Class Reference

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

#include <ChannelEntities.hpp>

Static Public Member Functions

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

Member Function Documentation

◆ createChannelInviteAsync()

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

Creates an invite to a selected Channel.

Parameters
dataPackageA CreateChannelInviteData structure.
Returns
A CoRoutine containing an InviteData.

Definition at line 371 of file ChannelEntities.cpp.

◆ createDMChannelAsync()

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

Collect a direct-Message Channel between the bot and the User.

Parameters
dataPackageA CreateDMChannelData structure.
Returns
A CoRoutine containing a Channel.

Definition at line 450 of file ChannelEntities.cpp.

◆ createGuildChannelAsync()

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

Creates a new Channel within a chosen Guild.

Parameters
dataPackageA CreateGuildChannelData structure.
Returns
A CoRoutine containing a Channel.

Definition at line 424 of file ChannelEntities.cpp.

◆ deleteChannelPermissionOverwritesAsync()

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

Delete the given Permissions overwrites for a given User or Role.

Parameters
dataPackageA DeleteChannelPermissionOverwritesData structure
Returns
A CoRoutine containing void.

Definition at line 384 of file ChannelEntities.cpp.

◆ deleteOrCloseChannelAsync()

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

Delete a Channel, or close a private message.

Parameters
dataPackageA DeleteOrCloseChannelData structure.
Returns
A CoRoutine containing a Channel.

Definition at line 337 of file ChannelEntities.cpp.

◆ editChannelPermissionOverwritesAsync()

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

Edit the given Permissions overwrites for a given User or Role.

Parameters
dataPackageAn EditChannelPermissionOverwritesData structure.
Returns
A CoRoutine containing void.

Definition at line 349 of file ChannelEntities.cpp.

◆ followNewsChannelAsync()

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

Follows a given new Channel with another Channel.

Parameters
dataPackageA FollowNewsChannelData structure.
Returns
A CoRoutine containing a Channel.

Definition at line 396 of file ChannelEntities.cpp.

◆ getCachedChannelAsync()

CoRoutine< ChannelData > DiscordCoreAPI::Channels::getCachedChannelAsync ( GetChannelData  dataPackage)
static

Collects a Channel from the library's cache.

Parameters
dataPackageA GetChannelData structure.
Returns
A CoRoutine containing a Channel.

Definition at line 304 of file ChannelEntities.cpp.

Here is the call graph for this function:

◆ getChannelAsync()

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

Collects a Channel from the Discord servers.

Parameters
dataPackageA GetChannelData structure.
Returns
A CoRoutine containing a Channel.

Definition at line 287 of file ChannelEntities.cpp.

Here is the caller graph for this function:

◆ getChannelInvitesAsync()

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

Collects a vector of the invites to a given Channel.

Parameters
dataPackageA GetChannelInvitesData structure.
Returns
A CoRoutine containing a InviteDataVector.

Definition at line 362 of file ChannelEntities.cpp.

◆ getGuildChannelsAsync()

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

Collects a list of Channels from a chosen Guild.

Parameters
dataPackageA GetGuildChannelsData structure.
Returns
A CoRoutine containing a ChannelVector.

Definition at line 415 of file ChannelEntities.cpp.

◆ getVoiceRegionsAsync()

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

Collect a list of voice regions that are usable for the RTC-Region option of a given Channel.

Returns
A CoRoutine containing a VoiceRegionDataVector.

Definition at line 462 of file ChannelEntities.cpp.

◆ modifyChannelAsync()

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

Modifies a Channel's properties.

Parameters
dataPackageA ModifyChannelData structure.
Returns
A CoRoutine containing a Channel.

Definition at line 316 of file ChannelEntities.cpp.

◆ modifyGuildChannelPositionsAsync()

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

Re-orders the Channel positions, within a chosen Guild.

Parameters
dataPackageA ModifyGuildChannelPositionsData structure.
Returns
A CoRoutine containing void.

Definition at line 437 of file ChannelEntities.cpp.

◆ triggerTypingIndicatorAsync()

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

Triggers the typing indicator for the bot in the given Channel.

Parameters
dataPackageA TriggerTypingIndicatorData structure.
Returns
A CoRoutine containing void.

Definition at line 406 of file ChannelEntities.cpp.


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