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

An interface class for the Message related Discord endpoints. More...

#include <MessageEntities.hpp>

Static Public Member Functions

static CoRoutine< MessagecreateMessageAsync (CreateMessageData dataPackage)
 Creates a new Message. More...
 
static CoRoutine< MessagecrosspostMessageAsync (CrosspostMessageData dataPackage)
 Crossposts a message from a News Channel to the following Channels. More...
 
static CoRoutine< void > deleteMessageAsync (DeleteMessageData dataPackage)
 Deletes a Message. More...
 
static CoRoutine< void > deleteMessagesBulkAsync (DeleteMessagesBulkData dataPackage)
 Deletes a collection of Messages. More...
 
static CoRoutine< MessageeditMessageAsync (EditMessageData dataPackage)
 Edit a Message. More...
 
static CoRoutine< MessagegetMessageAsync (GetMessageData dataPackage)
 Collects a Message from the Discord servers. More...
 
static CoRoutine< std::vector< Message > > getMessagesAsync (GetMessagesData dataPackage)
 Collects a collection of Message from the Discord servers. More...
 
static CoRoutine< std::vector< Message > > getPinnedMessagesAsync (GetPinnedMessagesData dataPackage)
 Collects a collection of pinned Messages from the Discord servers. More...
 
static CoRoutine< void > pinMessageAsync (PinMessageData dataPackage)
 Pins a Message to a given Channel. More...
 
static CoRoutine< void > unpinMessageAsync (UnpinMessageData dataPackage)
 Unpins a Message from a given Channel. More...
 

Member Function Documentation

◆ createMessageAsync()

CoRoutine< Message > DiscordCoreAPI::Messages::createMessageAsync ( CreateMessageData  dataPackage)
static

Creates a new Message.

Parameters
dataPackageA CreateMessageData structure.
Returns
A CoRoutine containing a Message.

Definition at line 425 of file MessageEntities.cpp.

◆ crosspostMessageAsync()

CoRoutine< Message > DiscordCoreAPI::Messages::crosspostMessageAsync ( CrosspostMessageData  dataPackage)
static

Crossposts a message from a News Channel to the following Channels.

Parameters
dataPackageA CrosspostMessageData structure.
Returns
A CoRoutine containing void.

Definition at line 440 of file MessageEntities.cpp.

◆ deleteMessageAsync()

CoRoutine< void > DiscordCoreAPI::Messages::deleteMessageAsync ( DeleteMessageData  dataPackage)
static

Deletes a Message.

Parameters
dataPackageA DeleteMessageData structure.
Returns
A CoRoutine containing void.

Definition at line 464 of file MessageEntities.cpp.

◆ deleteMessagesBulkAsync()

CoRoutine< void > DiscordCoreAPI::Messages::deleteMessagesBulkAsync ( DeleteMessagesBulkData  dataPackage)
static

Deletes a collection of Messages.

Parameters
dataPackageA DeleteMessagesBulkData structure.
Returns
A CoRoutine containing void.

Definition at line 481 of file MessageEntities.cpp.

◆ editMessageAsync()

CoRoutine< Message > DiscordCoreAPI::Messages::editMessageAsync ( EditMessageData  dataPackage)
static

Edit a Message.

Parameters
dataPackageAn EditMessageData structure.
Returns
A CoRoutine containing a Message.

Definition at line 449 of file MessageEntities.cpp.

◆ getMessageAsync()

CoRoutine< Message > DiscordCoreAPI::Messages::getMessageAsync ( GetMessageData  dataPackage)
static

Collects a Message from the Discord servers.

Parameters
dataPackageA GetMessageData structure.
Returns
A CoRoutine containing a Message.

Definition at line 416 of file MessageEntities.cpp.

◆ getMessagesAsync()

CoRoutine< std::vector< Message > > DiscordCoreAPI::Messages::getMessagesAsync ( GetMessagesData  dataPackage)
static

Collects a collection of Message from the Discord servers.

Parameters
dataPackageA GetMessagesData structure.
Returns
A CoRoutine containing a MessageVector.

Definition at line 379 of file MessageEntities.cpp.

◆ getPinnedMessagesAsync()

CoRoutine< std::vector< Message > > DiscordCoreAPI::Messages::getPinnedMessagesAsync ( GetPinnedMessagesData  dataPackage)
static

Collects a collection of pinned Messages from the Discord servers.

Parameters
dataPackageA GetPinnedMessagesData structure.
Returns
A CoRoutine containing a MessageVector.

Definition at line 494 of file MessageEntities.cpp.

◆ pinMessageAsync()

CoRoutine< void > DiscordCoreAPI::Messages::pinMessageAsync ( PinMessageData  dataPackage)
static

Pins a Message to a given Channel.

Parameters
dataPackageA PinMessageData structure.
Returns
A CoRoutine containing void.

Definition at line 503 of file MessageEntities.cpp.

◆ unpinMessageAsync()

CoRoutine< void > DiscordCoreAPI::Messages::unpinMessageAsync ( UnpinMessageData  dataPackage)
static

Unpins a Message from a given Channel.

Parameters
dataPackageAn UnpinMessageData structure.
Returns
A CoRoutine containing void.

Definition at line 515 of file MessageEntities.cpp.


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