DiscordCoreAPI::Messages Class Reference

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

#include <MessageEntities.hpp>

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

Member Function Documentation

createMessageAsync()

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

static

Parameters

dataPackage

A CreateMessageData structure.

Returns

A CoRoutine containing a Message.

Definition at line 391 of file MessageEntities.cpp.

crosspostMessageAsync()

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

static

Parameters

dataPackage

A CrosspostMessageData structure.

Returns

A CoRoutine containing void.

Definition at line 411 of file MessageEntities.cpp.

deleteMessageAsync()

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

static

Parameters

dataPackage

A DeleteMessageData structure.

Returns

A CoRoutine containing void.

Definition at line 441 of file MessageEntities.cpp.

deleteMessagesBulkAsync()

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

static

Parameters

dataPackage

A DeleteMessagesBulkData structure.

Returns

A CoRoutine containing void.

Definition at line 463 of file MessageEntities.cpp.

editMessageAsync()

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

static

Parameters

dataPackage

An EditMessageData structure.

Returns

A CoRoutine containing a Message.

Definition at line 421 of file MessageEntities.cpp.

getMessageAsync()

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

static

Parameters

dataPackage

A GetMessageData structure.

Returns

A CoRoutine containing a Message.

Definition at line 381 of file MessageEntities.cpp.

getMessagesAsync()

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

static

Parameters

dataPackage

A GetMessagesData structure.

Returns

A CoRoutine containing a MessageVector.

Definition at line 343 of file MessageEntities.cpp.

getPinnedMessagesAsync()

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

static

Parameters

dataPackage

A GetPinnedMessagesData structure.

Returns

A CoRoutine containing a MessageVector.

Definition at line 478 of file MessageEntities.cpp.

pinMessageAsync()

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

static

Parameters

dataPackage

A PinMessageData structure.

Returns

A CoRoutine containing void.

Definition at line 488 of file MessageEntities.cpp.

unpinMessageAsync()

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

static

Parameters

dataPackage

An UnpinMessageData structure.

Returns

A CoRoutine containing void.

Definition at line 500 of file MessageEntities.cpp.

---

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

• MessageEntities.hpp
• MessageEntities.cpp