DiscordCoreAPI::Threads Class Reference

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

#include <ThreadEntities.hpp>

Static Public Member Functions
static CoRoutine< void >	addThreadMemberAsync (AddThreadMemberData dataPackage)
	Adds a new User to a chosen Thread.
static CoRoutine< ActiveThreadsData >	getActiveGuildThreadsAsync (GetActiveGuildThreadsData dataPackage)
	Lists all of the active Threads of a chosen Guild.
static CoRoutine< ActiveThreadsData >	getActiveThreadsAsync (GetActiveThreadsData dataPackage)
	Collects a list of Threads from a given Channel.
static CoRoutine< ArchivedThreadsData >	getJoinedPrivateArchivedThreadsAsync (GetJoinedPrivateArchivedThreadsData dataPackage)
	Collects a list of joined private archived Threads from a given Channel.
static CoRoutine< ArchivedThreadsData >	getPrivateArchivedThreadsAsync (GetPrivateArchivedThreadsData dataPackage)
	Collects a list of private archived Threads from a given Channel.
static CoRoutine< ArchivedThreadsData >	getPublicArchivedThreadsAsync (GetPublicArchivedThreadsData dataPackage)
	Collects a list of public archived Threads from a given Channel.
static CoRoutine< ThreadMemberData >	getThreadMemberAsync (GetThreadMemberData dataPackage)
	Collects a ThreadMember if they exist.
static CoRoutine< std::vector< ThreadMemberData > >	getThreadMembersAsync (GetThreadMembersData dataPackage)
	Collects a list of ThreadMembers if they exist.
static CoRoutine< void >	joinThreadAsync (JoinThreadData dataPackage)
	Joins a Thread.
static CoRoutine< void >	leaveThreadAsync (LeaveThreadData dataPackage)
	Leaves a Thread.
static CoRoutine< void >	removeThreadMemberAsync (RemoveThreadMemberData dataPackage)
	Removes a User from a chosen Thread.
static CoRoutine< Thread >	startThreadInForumChannelAsync (StartThreadInForumChannelData dataPackage)
	Starts a Thread, in a forum channel.
static CoRoutine< Thread >	startThreadWithMessageAsync (StartThreadWithMessageData dataPackage)
	Starts a Thread, based on a starting Message.
static CoRoutine< Thread >	startThreadWithoutMessageAsync (StartThreadWithoutMessageData dataPackage)
	Starts a Thread, not based on a starting Message.

Member Function Documentation

addThreadMemberAsync()

CoRoutine< void > DiscordCoreAPI::Threads::addThreadMemberAsync ( AddThreadMemberData  dataPackage )

static

Parameters

dataPackage

An AddThreadMemberData structure.

Returns

A CoRoutine containing void.

Definition at line 153 of file ThreadEntities.cpp.

getActiveGuildThreadsAsync()

CoRoutine< ActiveThreadsData > DiscordCoreAPI::Threads::getActiveGuildThreadsAsync ( GetActiveGuildThreadsData  dataPackage )

static

Parameters

dataPackage

A ListActiveThreadsData structure.

Returns

A CoRoutine containing a vector<Channel>.

Definition at line 264 of file ThreadEntities.cpp.

getActiveThreadsAsync()

CoRoutine< ActiveThreadsData > DiscordCoreAPI::Threads::getActiveThreadsAsync ( GetActiveThreadsData  dataPackage )

static

Parameters

dataPackage

A GetActiveThreadsData structure.

Returns

A CoRoutine containing a ActiveThreadsData.

Definition at line 200 of file ThreadEntities.cpp.

getJoinedPrivateArchivedThreadsAsync()

CoRoutine< ArchivedThreadsData > DiscordCoreAPI::Threads::getJoinedPrivateArchivedThreadsAsync ( GetJoinedPrivateArchivedThreadsData  dataPackage )

static

Parameters

dataPackage

A GetPrivateArchivedThreadsData structure.

Returns

A CoRoutine containing a ArchivedThreadsData.

Definition at line 246 of file ThreadEntities.cpp.

getPrivateArchivedThreadsAsync()

CoRoutine< ArchivedThreadsData > DiscordCoreAPI::Threads::getPrivateArchivedThreadsAsync ( GetPrivateArchivedThreadsData  dataPackage )

static

Parameters

dataPackage

A GetPrivateArchivedThreadsData structure.

Returns

A CoRoutine containing a ArchivedThreadsData.

Definition at line 228 of file ThreadEntities.cpp.

getPublicArchivedThreadsAsync()

CoRoutine< ArchivedThreadsData > DiscordCoreAPI::Threads::getPublicArchivedThreadsAsync ( GetPublicArchivedThreadsData  dataPackage )

static

Parameters

dataPackage

A GetPublicArchivedThreadsData structure.

Returns

A CoRoutine containing a ArchivedThreadsData.

Definition at line 210 of file ThreadEntities.cpp.

getThreadMemberAsync()

CoRoutine< ThreadMemberData > DiscordCoreAPI::Threads::getThreadMemberAsync ( GetThreadMemberData  dataPackage )

static

Parameters

dataPackage

A GetThreadMemberData structure.

Returns

A CoRoutine containing a ThreadMemberData.

Definition at line 180 of file ThreadEntities.cpp.

getThreadMembersAsync()

CoRoutine< std::vector< ThreadMemberData > > DiscordCoreAPI::Threads::getThreadMembersAsync ( GetThreadMembersData  dataPackage )

static

Parameters

dataPackage

A GetThreadMembersData structure. returns A CoRoutine containing a vector<ThreadMemberData>.

Definition at line 190 of file ThreadEntities.cpp.

joinThreadAsync()

CoRoutine< void > DiscordCoreAPI::Threads::joinThreadAsync ( JoinThreadData  dataPackage )

static

Parameters

dataPackage

A JoinThreadData structure.

Returns

A CoRoutine containing void.

Definition at line 144 of file ThreadEntities.cpp.

leaveThreadAsync()

CoRoutine< void > DiscordCoreAPI::Threads::leaveThreadAsync ( LeaveThreadData  dataPackage )

static

Parameters

dataPackage

A LeaveThreadData structure.

Returns

A CoRoutine containing void.

Definition at line 162 of file ThreadEntities.cpp.

removeThreadMemberAsync()

CoRoutine< void > DiscordCoreAPI::Threads::removeThreadMemberAsync ( RemoveThreadMemberData  dataPackage )

static

Parameters

dataPackage

A RemoveThreadMemberData structure.

Returns

A CoRoutine containing void.

Definition at line 171 of file ThreadEntities.cpp.

startThreadInForumChannelAsync()

CoRoutine< Thread > DiscordCoreAPI::Threads::startThreadInForumChannelAsync ( StartThreadInForumChannelData  dataPackage )

static

Parameters

dataPackage

A StartThreadInForumChannelData structure.

Returns

A CoRoutine containing a Channel.

Definition at line 128 of file ThreadEntities.cpp.

startThreadWithMessageAsync()

CoRoutine< Thread > DiscordCoreAPI::Threads::startThreadWithMessageAsync ( StartThreadWithMessageData  dataPackage )

static

Parameters

dataPackage

A StartThreadWithMessageData structure.

Returns

A CoRoutine containing a Channel.

Definition at line 96 of file ThreadEntities.cpp.

startThreadWithoutMessageAsync()

CoRoutine< Thread > DiscordCoreAPI::Threads::startThreadWithoutMessageAsync ( StartThreadWithoutMessageData  dataPackage )

static

Parameters

dataPackage

A StartThreadWithoutMessageData structure.

Returns

A CoRoutine containing a Channel.

Definition at line 112 of file ThreadEntities.cpp.

---

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

• ThreadEntities.hpp
• ThreadEntities.cpp