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

An interface class for the WebHook related Discord endpoints;. More...

#include <WebHookEntities.hpp>

Static Public Member Functions

static CoRoutine< WebHookcreateWebHookAsync (CreateWebHookData dataPackage)
 Creates a new WebHook.
 
static CoRoutine< void > deleteWebHookAsync (DeleteWebHookData dataPackage)
 Deletes a single WebHook.
 
static CoRoutine< void > deleteWebHookMessageAsync (DeleteWebHookMessageData dataPackage)
 Deletes a WebHook Message.
 
static CoRoutine< void > deleteWebHookWithTokenAsync (DeleteWebHookWithTokenData dataPackage)
 Deletes a single WebHook, using its Token.
 
static CoRoutine< MessageeditWebHookMessageAsync (EditWebHookData dataPackage)
 Edits a WebHook Message.
 
static CoRoutine< MessageexecuteWebHookAsync (ExecuteWebHookData dataPackage)
 Executes a single WebHook.
 
static CoRoutine< std::vector< WebHook > > getChannelWebHooksAsync (GetChannelWebHooksData dataPackage)
 Collects a list of WebHooks from a chosen Channel.
 
static CoRoutine< std::vector< WebHook > > getGuildWebHooksAsync (GetGuildWebHooksData dataPackage)
 Collects a list of WebHooks from a chosen Guild.
 
static CoRoutine< WebHookgetWebHookAsync (GetWebHookData dataPackage)
 Collects a single WebHook.
 
static CoRoutine< MessagegetWebHookMessageAsync (GetWebHookMessageData dataPackage)
 Collects a WebHook Message.
 
static CoRoutine< WebHookgetWebHookWithTokenAsync (GetWebHookWithTokenData dataPackage)
 Collects a single WebHook, using the Token.
 
static CoRoutine< WebHookmodifyWebHookAsync (ModifyWebHookData dataPackage)
 Modifies a single WebHook.
 
static CoRoutine< WebHookmodifyWebHookWithTokenAsync (ModifyWebHookWithTokenData dataPackage)
 Modifies a single WebHook, using its Token.
 

Member Function Documentation

◆ createWebHookAsync()

CoRoutine< WebHook > DiscordCoreAPI::WebHooks::createWebHookAsync ( CreateWebHookData  dataPackage)
static
Parameters
dataPackageA GetMessageData structure.
Returns
A CoRoutine containing a WebHook.

Definition at line 275 of file WebHookEntities.cpp.

◆ deleteWebHookAsync()

CoRoutine< void > DiscordCoreAPI::WebHooks::deleteWebHookAsync ( DeleteWebHookData  dataPackage)
static
Parameters
dataPackageA DeleteWebHookData structure.
Returns
A CoRoutine containing void.

Definition at line 371 of file WebHookEntities.cpp.

◆ deleteWebHookMessageAsync()

CoRoutine< void > DiscordCoreAPI::WebHooks::deleteWebHookMessageAsync ( DeleteWebHookMessageData  dataPackage)
static
Parameters
dataPackageAn DeleteWebHookMessageData structure.
Returns
A CoRoutine containing a Message.

Definition at line 451 of file WebHookEntities.cpp.

◆ deleteWebHookWithTokenAsync()

CoRoutine< void > DiscordCoreAPI::WebHooks::deleteWebHookWithTokenAsync ( DeleteWebHookWithTokenData  dataPackage)
static
Parameters
dataPackageA DeleteWebHookWithTokenData structure.
Returns
A CoRoutine containing void.

Definition at line 380 of file WebHookEntities.cpp.

◆ editWebHookMessageAsync()

CoRoutine< Message > DiscordCoreAPI::WebHooks::editWebHookMessageAsync ( EditWebHookData  dataPackage)
static
Parameters
dataPackageAn EditWebHookMessageData structure.
Returns
A CoRoutine containing a Message.

Definition at line 429 of file WebHookEntities.cpp.

◆ executeWebHookAsync()

CoRoutine< Message > DiscordCoreAPI::WebHooks::executeWebHookAsync ( ExecuteWebHookData  dataPackage)
static
Parameters
dataPackageAn ExecuteWebHookData structure.
Returns
A CoRoutine containing a Message.

Definition at line 389 of file WebHookEntities.cpp.

◆ getChannelWebHooksAsync()

CoRoutine< std::vector< WebHook > > DiscordCoreAPI::WebHooks::getChannelWebHooksAsync ( GetChannelWebHooksData  dataPackage)
static
Parameters
dataPackageA GetChannelWebHooksData structure.
Returns
A CoRoutine containing a WebHookVector.

Definition at line 293 of file WebHookEntities.cpp.

◆ getGuildWebHooksAsync()

CoRoutine< std::vector< WebHook > > DiscordCoreAPI::WebHooks::getGuildWebHooksAsync ( GetGuildWebHooksData  dataPackage)
static
Parameters
dataPackageA GetGuildWebHooksData structure.
Returns
A CoRoutine containing a WebHookVector.

Definition at line 302 of file WebHookEntities.cpp.

◆ getWebHookAsync()

CoRoutine< WebHook > DiscordCoreAPI::WebHooks::getWebHookAsync ( GetWebHookData  dataPackage)
static
Parameters
dataPackageA GetWebHookData structure.
Returns
A CoRoutine containing a WebHook.

Definition at line 311 of file WebHookEntities.cpp.

◆ getWebHookMessageAsync()

CoRoutine< Message > DiscordCoreAPI::WebHooks::getWebHookMessageAsync ( GetWebHookMessageData  dataPackage)
static
Parameters
dataPackageAn GetWebHookMessageData structure.
Returns
A CoRoutine containing a Message.

Definition at line 417 of file WebHookEntities.cpp.

◆ getWebHookWithTokenAsync()

CoRoutine< WebHook > DiscordCoreAPI::WebHooks::getWebHookWithTokenAsync ( GetWebHookWithTokenData  dataPackage)
static
Parameters
dataPackageA GetWebHookWithTokenData structure.
Returns
A CoRoutine containing a WebHook.

Definition at line 320 of file WebHookEntities.cpp.

◆ modifyWebHookAsync()

CoRoutine< WebHook > DiscordCoreAPI::WebHooks::modifyWebHookAsync ( ModifyWebHookData  dataPackage)
static
Parameters
dataPackageA ModifyWebHookData structure.
Returns
A CoRoutine containing a WebHook.

Definition at line 329 of file WebHookEntities.cpp.

◆ modifyWebHookWithTokenAsync()

CoRoutine< WebHook > DiscordCoreAPI::WebHooks::modifyWebHookWithTokenAsync ( ModifyWebHookWithTokenData  dataPackage)
static
Parameters
dataPackageA ModifyWebHookWithTokenData structure.
Returns
A CoRoutine containing a WebHook.

Definition at line 350 of file WebHookEntities.cpp.


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