DiscordCoreAPI
A Discord bot library written in C++, with custom asynchronous coroutines.
Loading...
Searching...
No Matches
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. More...
 
static CoRoutine< ActiveThreadsDatagetActiveGuildThreadsAsync (GetActiveGuildThreadsData dataPackage)
 Lists all of the active Threads of a chosen Guild. More...
 
static CoRoutine< ActiveThreadsDatagetActiveThreadsAsync (GetActiveThreadsData dataPackage)
 Collects a list of Threads from a given Channel. More...
 
static CoRoutine< ArchivedThreadsDatagetJoinedPrivateArchivedThreadsAsync (GetJoinedPrivateArchivedThreadsData dataPackage)
 Collects a list of joined private archived Threads from a given Channel. More...
 
static CoRoutine< ArchivedThreadsDatagetPrivateArchivedThreadsAsync (GetPrivateArchivedThreadsData dataPackage)
 Collects a list of private archived Threads from a given Channel. More...
 
static CoRoutine< ArchivedThreadsDatagetPublicArchivedThreadsAsync (GetPublicArchivedThreadsData dataPackage)
 Collects a list of public archived Threads from a given Channel. More...
 
static CoRoutine< ThreadMemberDatagetThreadMemberAsync (GetThreadMemberData dataPackage)
 Collects a ThreadMember if they exist. More...
 
static CoRoutine< std::vector< ThreadMemberData > > getThreadMembersAsync (GetThreadMembersData dataPackage)
 Collects a list of ThreadMembers if they exist. More...
 
static CoRoutine< void > joinThreadAsync (JoinThreadData dataPackage)
 Joins a Thread. More...
 
static CoRoutine< void > leaveThreadAsync (LeaveThreadData dataPackage)
 Leaves a Thread. More...
 
static CoRoutine< void > removeThreadMemberAsync (RemoveThreadMemberData dataPackage)
 Removes a User from a chosen Thread. More...
 
static CoRoutine< ThreadstartThreadInForumChannelAsync (StartThreadInForumChannelData dataPackage)
 Starts a Thread, in a forum channel. More...
 
static CoRoutine< ThreadstartThreadWithMessageAsync (StartThreadWithMessageData dataPackage)
 Starts a Thread, based on a starting Message. More...
 
static CoRoutine< ThreadstartThreadWithoutMessageAsync (StartThreadWithoutMessageData dataPackage)
 Starts a Thread, not based on a starting Message. More...
 

Member Function Documentation

◆ addThreadMemberAsync()

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

Adds a new User to a chosen Thread.

Parameters
dataPackageAn AddThreadMemberData structure.
Returns
A CoRoutine containing void.

Definition at line 141 of file ThreadEntities.cpp.

◆ getActiveGuildThreadsAsync()

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

Lists all of the active Threads of a chosen Guild.

Parameters
dataPackageA ListActiveThreadsData structure.
Returns
A CoRoutine containing a vector<Channel>.

Definition at line 246 of file ThreadEntities.cpp.

◆ getActiveThreadsAsync()

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

Collects a list of Threads from a given Channel.

Parameters
dataPackageA GetActiveThreadsData structure.
Returns
A CoRoutine containing a ActiveThreadsData.

Definition at line 186 of file ThreadEntities.cpp.

◆ getJoinedPrivateArchivedThreadsAsync()

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

Collects a list of joined private archived Threads from a given Channel.

Parameters
dataPackageA GetPrivateArchivedThreadsData structure.
Returns
A CoRoutine containing a ArchivedThreadsData.

Definition at line 229 of file ThreadEntities.cpp.

◆ getPrivateArchivedThreadsAsync()

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

Collects a list of private archived Threads from a given Channel.

Parameters
dataPackageA GetPrivateArchivedThreadsData structure.
Returns
A CoRoutine containing a ArchivedThreadsData.

Definition at line 212 of file ThreadEntities.cpp.

◆ getPublicArchivedThreadsAsync()

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

Collects a list of public archived Threads from a given Channel.

Parameters
dataPackageA GetPublicArchivedThreadsData structure.
Returns
A CoRoutine containing a ArchivedThreadsData.

Definition at line 195 of file ThreadEntities.cpp.

◆ getThreadMemberAsync()

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

Collects a ThreadMember if they exist.

Parameters
dataPackageA GetThreadMemberData structure.
Returns
A CoRoutine containing a ThreadMemberData.

Definition at line 168 of file ThreadEntities.cpp.

◆ getThreadMembersAsync()

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

Collects a list of ThreadMembers if they exist.

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

Definition at line 177 of file ThreadEntities.cpp.

◆ joinThreadAsync()

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

Joins a Thread.

Parameters
dataPackageA JoinThreadData structure.
Returns
A CoRoutine containing void.

Definition at line 132 of file ThreadEntities.cpp.

◆ leaveThreadAsync()

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

Leaves a Thread.

Parameters
dataPackageA LeaveThreadData structure.
Returns
A CoRoutine containing void.

Definition at line 150 of file ThreadEntities.cpp.

◆ removeThreadMemberAsync()

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

Removes a User from a chosen Thread.

Parameters
dataPackageA RemoveThreadMemberData structure.
Returns
A CoRoutine containing void.

Definition at line 159 of file ThreadEntities.cpp.

◆ startThreadInForumChannelAsync()

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

Starts a Thread, in a forum channel.

Parameters
dataPackageA StartThreadInForumChannelData structure.
Returns
A CoRoutine containing a Channel.

Definition at line 119 of file ThreadEntities.cpp.

◆ startThreadWithMessageAsync()

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

Starts a Thread, based on a starting Message.

Parameters
dataPackageA StartThreadWithMessageData structure.
Returns
A CoRoutine containing a Channel.

Definition at line 93 of file ThreadEntities.cpp.

◆ startThreadWithoutMessageAsync()

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

Starts a Thread, not based on a starting Message.

Parameters
dataPackageA StartThreadWithoutMessageData structure.
Returns
A CoRoutine containing a Channel.

Definition at line 106 of file ThreadEntities.cpp.


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