DiscordCoreAPI::WebHooks Class Reference

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

#include <WebHookEntities.hpp>

Static Public Member Functions
static CoRoutine< WebHook >	createWebHookAsync (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< Message >	editWebHookMessageAsync (EditWebHookData dataPackage)
	Edits a WebHook Message.
static CoRoutine< Message >	executeWebHookAsync (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< WebHook >	getWebHookAsync (GetWebHookData dataPackage)
	Collects a single WebHook.
static CoRoutine< Message >	getWebHookMessageAsync (GetWebHookMessageData dataPackage)
	Collects a WebHook Message.
static CoRoutine< WebHook >	getWebHookWithTokenAsync (GetWebHookWithTokenData dataPackage)
	Collects a single WebHook, using the Token.
static CoRoutine< WebHook >	modifyWebHookAsync (ModifyWebHookData dataPackage)
	Modifies a single WebHook.
static CoRoutine< WebHook >	modifyWebHookWithTokenAsync (ModifyWebHookWithTokenData dataPackage)
	Modifies a single WebHook, using its Token.

Member Function Documentation

createWebHookAsync()

CoRoutine< WebHook > DiscordCoreAPI::WebHooks::createWebHookAsync ( CreateWebHookData  dataPackage )

static

Parameters

dataPackage

A GetMessageData structure.

Returns

A CoRoutine containing a WebHook.

Definition at line 276 of file WebHookEntities.cpp.

deleteWebHookAsync()

CoRoutine< void > DiscordCoreAPI::WebHooks::deleteWebHookAsync ( DeleteWebHookData  dataPackage )

static

Parameters

dataPackage

A DeleteWebHookData structure.

Returns

A CoRoutine containing void.

Definition at line 379 of file WebHookEntities.cpp.

deleteWebHookMessageAsync()

CoRoutine< void > DiscordCoreAPI::WebHooks::deleteWebHookMessageAsync ( DeleteWebHookMessageData  dataPackage )

static

Parameters

dataPackage

An DeleteWebHookMessageData structure.

Returns

A CoRoutine containing a Message.

Definition at line 464 of file WebHookEntities.cpp.

deleteWebHookWithTokenAsync()

CoRoutine< void > DiscordCoreAPI::WebHooks::deleteWebHookWithTokenAsync ( DeleteWebHookWithTokenData  dataPackage )

static

Parameters

dataPackage

A DeleteWebHookWithTokenData structure.

Returns

A CoRoutine containing void.

Definition at line 388 of file WebHookEntities.cpp.

editWebHookMessageAsync()

CoRoutine< Message > DiscordCoreAPI::WebHooks::editWebHookMessageAsync ( EditWebHookData  dataPackage )

static

Parameters

dataPackage

An EditWebHookMessageData structure.

Returns

A CoRoutine containing a Message.

Definition at line 440 of file WebHookEntities.cpp.

executeWebHookAsync()

CoRoutine< Message > DiscordCoreAPI::WebHooks::executeWebHookAsync ( ExecuteWebHookData  dataPackage )

static

Parameters

dataPackage

An ExecuteWebHookData structure.

Returns

A CoRoutine containing a Message.

Definition at line 397 of file WebHookEntities.cpp.

getChannelWebHooksAsync()

CoRoutine< std::vector< WebHook > > DiscordCoreAPI::WebHooks::getChannelWebHooksAsync ( GetChannelWebHooksData  dataPackage )

static

Parameters

dataPackage

A GetChannelWebHooksData structure.

Returns

A CoRoutine containing a WebHookVector.

Definition at line 295 of file WebHookEntities.cpp.

getGuildWebHooksAsync()

CoRoutine< std::vector< WebHook > > DiscordCoreAPI::WebHooks::getGuildWebHooksAsync ( GetGuildWebHooksData  dataPackage )

static

Parameters

dataPackage

A GetGuildWebHooksData structure.

Returns

A CoRoutine containing a WebHookVector.

Definition at line 305 of file WebHookEntities.cpp.

getWebHookAsync()

CoRoutine< WebHook > DiscordCoreAPI::WebHooks::getWebHookAsync ( GetWebHookData  dataPackage )

static

Parameters

dataPackage

A GetWebHookData structure.

Returns

A CoRoutine containing a WebHook.

Definition at line 315 of file WebHookEntities.cpp.

getWebHookMessageAsync()

CoRoutine< Message > DiscordCoreAPI::WebHooks::getWebHookMessageAsync ( GetWebHookMessageData  dataPackage )

static

Parameters

dataPackage

An GetWebHookMessageData structure.

Returns

A CoRoutine containing a Message.

Definition at line 426 of file WebHookEntities.cpp.

getWebHookWithTokenAsync()

CoRoutine< WebHook > DiscordCoreAPI::WebHooks::getWebHookWithTokenAsync ( GetWebHookWithTokenData  dataPackage )

static

Parameters

dataPackage

A GetWebHookWithTokenData structure.

Returns

A CoRoutine containing a WebHook.

Definition at line 325 of file WebHookEntities.cpp.

modifyWebHookAsync()

CoRoutine< WebHook > DiscordCoreAPI::WebHooks::modifyWebHookAsync ( ModifyWebHookData  dataPackage )

static

Parameters

dataPackage

A ModifyWebHookData structure.

Returns

A CoRoutine containing a WebHook.

Definition at line 335 of file WebHookEntities.cpp.

modifyWebHookWithTokenAsync()

CoRoutine< WebHook > DiscordCoreAPI::WebHooks::modifyWebHookWithTokenAsync ( ModifyWebHookWithTokenData  dataPackage )

static

Parameters

dataPackage

A ModifyWebHookWithTokenData structure.

Returns

A CoRoutine containing a WebHook.

Definition at line 357 of file WebHookEntities.cpp.

---

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

• WebHookEntities.hpp
• WebHookEntities.cpp