discord_core_api::threads Class Reference

An interface class for the thread_data related endpoints. More...

#include <ThreadEntities.hpp>

Static Public Member Functions
static co_routine< void >	addThreadMemberAsync (const add_thread_member_data dataPackage)
	Adds a new user_data to a chosen thread_data. More...
static co_routine< active_threads_data >	getActiveGuildThreadsAsync (const get_active_guild_threads_data dataPackage)
	Lists all of the active threads of a chosen guild. More...
static co_routine< active_threads_data >	getActiveThreadsAsync (const get_active_threads_data dataPackage)
	Collects a list of threads from a given channel. More...
static co_routine< archived_threads_data >	getJoinedPrivateArchivedThreadsAsync (const get_joined_private_archived_threads_data dataPackage)
	Collects a list of joined protected archived threads from a given channel. More...
static co_routine< archived_threads_data >	getPrivateArchivedThreadsAsync (const get_private_archived_threads_data dataPackage)
	Collects a list of protected archived threads from a given channel. More...
static co_routine< archived_threads_data >	getPublicArchivedThreadsAsync (const get_public_archived_threads_data dataPackage)
	Collects a list of public archived threads from a given channel. More...
static co_routine< thread_member_data >	getThreadMemberAsync (const get_thread_member_data dataPackage)
	Collects a thread_member if they exist. More...
static co_routine< jsonifier::vector< thread_member_data > >	getThreadMembersAsync (const get_thread_members_data dataPackage)
	Collects a list of thread_members if they exist. More...
static co_routine< void >	joinThreadAsync (const join_thread_data dataPackage)
	Joins a thread_data. More...
static co_routine< void >	leaveThreadAsync (const leave_thread_data dataPackage)
	Leaves a thread_data. More...
static co_routine< void >	removeThreadMemberAsync (const remove_thread_member_data dataPackage)
	Removes a user from a chosen thread_data. More...
static co_routine< thread_data >	startThreadInForumChannelAsync (const start_thread_in_forum_channel_data dataPackage)
	Starts a thread_data, in a forum channel. More...
static co_routine< thread_data >	startThreadWithMessageAsync (const start_thread_with_message_data dataPackage)
	Starts a thread_data, based on a starting message_data. More...
static co_routine< thread_data >	startThreadWithoutMessageAsync (const start_thread_without_message_data dataPackage)
	Starts a thread_data, not based on a starting message_data. More...

Member Function Documentation

addThreadMemberAsync()

co_routine< void > discord_core_api::threads::addThreadMemberAsync ( const add_thread_member_data  dataPackage )

static

Parameters

dataPackage

an add_thread_member_data structure.

Returns

a co_routine containing void.

Definition at line 126 of file ThreadEntities.cpp.

getActiveGuildThreadsAsync()

co_routine< active_threads_data > discord_core_api::threads::getActiveGuildThreadsAsync ( const get_active_guild_threads_data  dataPackage )

static

Parameters

dataPackage

a list_active_threads_data structure.

Returns

a co_routine containing a vector<channel_data>.

Definition at line 246 of file ThreadEntities.cpp.

getActiveThreadsAsync()

co_routine< active_threads_data > discord_core_api::threads::getActiveThreadsAsync ( const get_active_threads_data  dataPackage )

static

Parameters

dataPackage

a get_active_threads_data structure.

Returns

a co_routine containing a active_threads_data.

Definition at line 178 of file ThreadEntities.cpp.

getJoinedPrivateArchivedThreadsAsync()

co_routine< archived_threads_data > discord_core_api::threads::getJoinedPrivateArchivedThreadsAsync ( const get_joined_private_archived_threads_data  dataPackage )

static

Parameters

dataPackage

a get_private_archived_threads_data structure.

Returns

a co_routine containing a archived_threads_data.

Definition at line 227 of file ThreadEntities.cpp.

getPrivateArchivedThreadsAsync()

co_routine< archived_threads_data > discord_core_api::threads::getPrivateArchivedThreadsAsync ( const get_private_archived_threads_data  dataPackage )

static

Parameters

dataPackage

a get_private_archived_threads_data structure.

Returns

a co_routine containing a archived_threads_data.

Definition at line 208 of file ThreadEntities.cpp.

getPublicArchivedThreadsAsync()

co_routine< archived_threads_data > discord_core_api::threads::getPublicArchivedThreadsAsync ( const get_public_archived_threads_data  dataPackage )

static

Parameters

dataPackage

a get_public_archived_threads_data structure.

Returns

a co_routine containing a archived_threads_data.

Definition at line 189 of file ThreadEntities.cpp.

getThreadMemberAsync()

co_routine< thread_member_data > discord_core_api::threads::getThreadMemberAsync ( const get_thread_member_data  dataPackage )

static

Parameters

dataPackage

a get_thread_member_data structure.

Returns

a co_routine containing a thread_member_data.

Definition at line 156 of file ThreadEntities.cpp.

getThreadMembersAsync()

co_routine< jsonifier::vector< thread_member_data > > discord_core_api::threads::getThreadMembersAsync ( const get_thread_members_data  dataPackage )

static

Parameters

dataPackage

a get_thread_members_data structure.

Returns

a co_routine containing a vector<thread_member_data>.

Definition at line 167 of file ThreadEntities.cpp.

joinThreadAsync()

co_routine< void > discord_core_api::threads::joinThreadAsync ( const join_thread_data  dataPackage )

static

Parameters

dataPackage

a join_thread_data structure.

Returns

a co_routine containing void.

Definition at line 116 of file ThreadEntities.cpp.

leaveThreadAsync()

co_routine< void > discord_core_api::threads::leaveThreadAsync ( const leave_thread_data  dataPackage )

static

Parameters

dataPackage

a leave_thread_data structure.

Returns

a co_routine containing void.

Definition at line 136 of file ThreadEntities.cpp.

removeThreadMemberAsync()

co_routine< void > discord_core_api::threads::removeThreadMemberAsync ( const remove_thread_member_data  dataPackage )

static

Parameters

dataPackage

a remove_thread_member_data structure.

Returns

a co_routine containing void.

Definition at line 146 of file ThreadEntities.cpp.

startThreadInForumChannelAsync()

co_routine< thread_data > discord_core_api::threads::startThreadInForumChannelAsync ( const start_thread_in_forum_channel_data  dataPackage )

static

Parameters

dataPackage

a start_thread_in_forum_channel_data structure.

Returns

a co_routine containing a channel.

Definition at line 101 of file ThreadEntities.cpp.

startThreadWithMessageAsync()

co_routine< thread_data > discord_core_api::threads::startThreadWithMessageAsync ( const start_thread_with_message_data  dataPackage )

static

Parameters

dataPackage

a start_thread_with_message_data structure.

Returns

a co_routine containing a channel.

Definition at line 71 of file ThreadEntities.cpp.

startThreadWithoutMessageAsync()

co_routine< thread_data > discord_core_api::threads::startThreadWithoutMessageAsync ( const start_thread_without_message_data  dataPackage )

static

Parameters

dataPackage

a start_thread_without_message_data structure.

Returns

a co_routine containing a channel.

Definition at line 86 of file ThreadEntities.cpp.

---

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

• ThreadEntities.hpp
• ThreadEntities.cpp