discord_core_api::messages Class Reference

An interface class for the message_data related discord endpoints. More...

#include <MessageEntities.hpp>

Static Public Member Functions
static co_routine< message_data >	createMessageAsync (const create_message_data dataPackage)
	Creates a new message_data. More...
static co_routine< message_data >	crosspostMessageAsync (const crosspost_message_data dataPackage)
	Crossposts a message from a news channel_data to the following channels. More...
static co_routine< void >	deleteMessageAsync (const delete_message_data dataPackage)
	Deletes a message. More...
static co_routine< void >	deleteMessagesBulkAsync (const delete_messages_bulk_data dataPackage)
	Deletes a collection of messages. More...
static co_routine< message_data >	editMessageAsync (const edit_message_data dataPackage)
	Edit a message. More...
static co_routine< message_data >	getMessageAsync (const get_message_data dataPackage)
	Collects a message from the discord servers. More...
static co_routine< jsonifier::vector< message_data > >	getMessagesAsync (const get_messages_data dataPackage)
	Collects a collection of message from the discord servers. More...
static co_routine< jsonifier::vector< message_data > >	getPinnedMessagesAsync (const get_pinned_messages_data dataPackage)
	Collects a collection of pinned messages from the discord servers. More...
static co_routine< void >	pinMessageAsync (const pin_message_data dataPackage)
	Pins a message to a given channel. More...
static co_routine< void >	unpinMessageAsync (const unpin_message_data dataPackage)
	Unpins a message from a given channel. More...

Member Function Documentation

createMessageAsync()

co_routine< message_data > discord_core_api::messages::createMessageAsync ( const create_message_data  dataPackage )

static

Parameters

dataPackage

a create_message_data structure.

Returns

A co_routine containing a message.

Definition at line 230 of file MessageEntities.cpp.

crosspostMessageAsync()

co_routine< message_data > discord_core_api::messages::crosspostMessageAsync ( const crosspost_message_data  dataPackage )

static

Parameters

dataPackage

a crosspost_message_data structure.

Returns

A co_routine containing void.

Definition at line 247 of file MessageEntities.cpp.

deleteMessageAsync()

co_routine< void > discord_core_api::messages::deleteMessageAsync ( const delete_message_data  dataPackage )

static

Parameters

dataPackage

a delete_message_data structure.

Returns

A co_routine containing void.

Definition at line 275 of file MessageEntities.cpp.

Here is the call graph for this function:

deleteMessagesBulkAsync()

co_routine< void > discord_core_api::messages::deleteMessagesBulkAsync ( const delete_messages_bulk_data  dataPackage )

static

Parameters

dataPackage

a delete_messages_bulk_data structure.

Returns

A co_routine containing void.

Definition at line 297 of file MessageEntities.cpp.

editMessageAsync()

co_routine< message_data > discord_core_api::messages::editMessageAsync ( const edit_message_data  dataPackage )

static

Parameters

dataPackage

an edit_message_data structure.

Returns

A co_routine containing a message.

Definition at line 258 of file MessageEntities.cpp.

getMessageAsync()

co_routine< message_data > discord_core_api::messages::getMessageAsync ( const get_message_data  dataPackage )

static

Parameters

dataPackage

a get_message_data structure.

Returns

A co_routine containing a message.

Definition at line 219 of file MessageEntities.cpp.

getMessagesAsync()

co_routine< jsonifier::vector< message_data > > discord_core_api::messages::getMessagesAsync ( const get_messages_data  dataPackage )

static

Parameters

dataPackage

a get_messages_data structure.

Returns

A co_routine containing a jsonifier::vector<message_data>.

Definition at line 180 of file MessageEntities.cpp.

getPinnedMessagesAsync()

co_routine< jsonifier::vector< message_data > > discord_core_api::messages::getPinnedMessagesAsync ( const get_pinned_messages_data  dataPackage )

static

Parameters

dataPackage

a get_pinned_messages_data structure.

Returns

A co_routine containing a jsonifier::vector<message_data>.

Definition at line 310 of file MessageEntities.cpp.

pinMessageAsync()

co_routine< void > discord_core_api::messages::pinMessageAsync ( const pin_message_data  dataPackage )

static

Parameters

dataPackage

a pin_message_data structure.

Returns

A co_routine containing void.

Definition at line 321 of file MessageEntities.cpp.

unpinMessageAsync()

co_routine< void > discord_core_api::messages::unpinMessageAsync ( const unpin_message_data  dataPackage )

static

Parameters

dataPackage

an unpin_message_data structure.

Returns

A co_routine containing void.

Definition at line 334 of file MessageEntities.cpp.

---

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

• MessageEntities.hpp
• MessageEntities.cpp