discord_core_api::web_hooks Class Reference

An interface class for the web_hook_data related discord endpoints;. More...

#include <WebHookEntities.hpp>

Static Public Member Functions
static co_routine< web_hook_data >	createWebHookAsync (const create_web_hook_data dataPackage)
	Creates a new web_hook_data. More...
static co_routine< void >	deleteWebHookAsync (const delete_web_hook_data dataPackage)
	Deletes a single web_hook_data. More...
static co_routine< void >	deleteWebHookMessageAsync (const delete_web_hook_message_data dataPackage)
	Deletes a web_hook message_data. More...
static co_routine< void >	deleteWebHookWithTokenAsync (const delete_web_hook_with_token_data dataPackage)
	Deletes a single web_hook_data, using its token. More...
static co_routine< message_data >	editWebHookMessageAsync (const edit_web_hook_data dataPackage)
	Edits a web_hook message_data. More...
static co_routine< message_data >	executeWebHookAsync (const execute_web_hook_data dataPackage)
	Executes a single web_hook_data. More...
static co_routine< jsonifier::vector< web_hook_data > >	getChannelWebHooksAsync (const get_channel_web_hooks_data dataPackage)
	Collects a list of web_hooks from a chosen channel_data. More...
static co_routine< jsonifier::vector< web_hook_data > >	getGuildWebHooksAsync (const get_guild_web_hooks_data dataPackage)
	Collects a list of web_hooks from a chosen guild. More...
static co_routine< web_hook_data >	getWebHookAsync (const get_web_hook_data dataPackage)
	Collects a single web_hook_data. More...
static co_routine< message_data >	getWebHookMessageAsync (const get_web_hook_message_data dataPackage)
	Collects a web_hook message_data. More...
static co_routine< web_hook_data >	getWebHookWithTokenAsync (const get_web_hook_with_token_data dataPackage)
	Collects a single web_hook_data, using the token. More...
static co_routine< web_hook_data >	modifyWebHookAsync (const modify_web_hook_data dataPackage)
	Modifies a single web_hook_data. More...
static co_routine< web_hook_data >	modifyWebHookWithTokenAsync (const modify_web_hook_with_token_data dataPackage)
	Modifies a single web_hook_data, using its token. More...

Member Function Documentation

createWebHookAsync()

co_routine< web_hook_data > discord_core_api::web_hooks::createWebHookAsync ( const create_web_hook_data  dataPackage )

static

Parameters

dataPackage

a get_message_data structure.

Returns

a co_routine containing a web_hook.

Definition at line 243 of file WebHookEntities.cpp.

deleteWebHookAsync()

co_routine< void > discord_core_api::web_hooks::deleteWebHookAsync ( const delete_web_hook_data  dataPackage )

static

Parameters

dataPackage

a delete_web_hook_data structure.

Returns

a co_routine containing void.

Definition at line 323 of file WebHookEntities.cpp.

deleteWebHookMessageAsync()

co_routine< void > discord_core_api::web_hooks::deleteWebHookMessageAsync ( const delete_web_hook_message_data  dataPackage )

static

Parameters

dataPackage

an delete_web_hook_message_data structure.

Returns

a co_routine containing a message.

Definition at line 405 of file WebHookEntities.cpp.

deleteWebHookWithTokenAsync()

co_routine< void > discord_core_api::web_hooks::deleteWebHookWithTokenAsync ( const delete_web_hook_with_token_data  dataPackage )

static

Parameters

dataPackage

a delete_web_hook_with_token_data structure.

Returns

a co_routine containing void.

Definition at line 333 of file WebHookEntities.cpp.

editWebHookMessageAsync()

co_routine< message_data > discord_core_api::web_hooks::editWebHookMessageAsync ( const edit_web_hook_data  dataPackage )

static

Parameters

dataPackage

an edit_web_hook_data_message_data structure.

Returns

a co_routine containing a message.

Definition at line 384 of file WebHookEntities.cpp.

executeWebHookAsync()

co_routine< message_data > discord_core_api::web_hooks::executeWebHookAsync ( const execute_web_hook_data  dataPackage )

static

Parameters

dataPackage

an execute_web_hook_data structure.

Returns

a co_routine containing a message.

Definition at line 343 of file WebHookEntities.cpp.

getChannelWebHooksAsync()

co_routine< jsonifier::vector< web_hook_data > > discord_core_api::web_hooks::getChannelWebHooksAsync ( const get_channel_web_hooks_data  dataPackage )

static

Parameters

dataPackage

a get_channel_web_hooks_data structure.

Returns

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

Definition at line 255 of file WebHookEntities.cpp.

getGuildWebHooksAsync()

co_routine< jsonifier::vector< web_hook_data > > discord_core_api::web_hooks::getGuildWebHooksAsync ( const get_guild_web_hooks_data  dataPackage )

static

Parameters

dataPackage

a get_guild_web_hooks_data structure.

Returns

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

Definition at line 266 of file WebHookEntities.cpp.

getWebHookAsync()

co_routine< web_hook_data > discord_core_api::web_hooks::getWebHookAsync ( const get_web_hook_data  dataPackage )

static

Parameters

dataPackage

a get_web_hook_data structure.

Returns

a co_routine containing a web_hook.

Definition at line 277 of file WebHookEntities.cpp.

getWebHookMessageAsync()

co_routine< message_data > discord_core_api::web_hooks::getWebHookMessageAsync ( const get_web_hook_message_data  dataPackage )

static

Parameters

dataPackage

an get_web_hook_message_data structure.

Returns

a co_routine containing a message.

Definition at line 370 of file WebHookEntities.cpp.

getWebHookWithTokenAsync()

co_routine< web_hook_data > discord_core_api::web_hooks::getWebHookWithTokenAsync ( const get_web_hook_with_token_data  dataPackage )

static

Parameters

dataPackage

a get_web_hook_with_token_data structure.

Returns

a co_routine containing a web_hook.

Definition at line 288 of file WebHookEntities.cpp.

modifyWebHookAsync()

co_routine< web_hook_data > discord_core_api::web_hooks::modifyWebHookAsync ( const modify_web_hook_data  dataPackage )

static

Parameters

dataPackage

a modify_web_hook_data structure.

Returns

a co_routine containing a web_hook.

Definition at line 299 of file WebHookEntities.cpp.

modifyWebHookWithTokenAsync()

co_routine< web_hook_data > discord_core_api::web_hooks::modifyWebHookWithTokenAsync ( const modify_web_hook_with_token_data  dataPackage )

static

Parameters

dataPackage

a modify_web_hook_with_token_data structure.

Returns

a co_routine containing a web_hook.

Definition at line 311 of file WebHookEntities.cpp.

---

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

• WebHookEntities.hpp
• WebHookEntities.cpp