DiscordCoreAPI
A Discord bot library written in C++, with custom asynchronous coroutines.
Loading...
Searching...
No Matches
DiscordCoreAPI::ObjectCollector< Object > Class Template Reference

ObjectCollector, for collecting Objects from a Channel. More...

#include <Utilities.hpp>

Public Member Functions

CoRoutine< ObjectCollectorReturnData< Object > > collectObjects (int32_t quantityToCollect, int32_t msToCollectForNew, ObjectFilter< Object > filteringFunctionNew)
 Begin waiting for Objects. More...
 

Member Function Documentation

◆ collectObjects()

template<typename Object >
CoRoutine< ObjectCollectorReturnData< Object > > DiscordCoreAPI::ObjectCollector< Object >::collectObjects ( int32_t  quantityToCollect,
int32_t  msToCollectForNew,
ObjectFilter< Object >  filteringFunctionNew 
)
inline

Begin waiting for Objects.

Parameters
quantityToCollectMaximum quantity of Objects to collect before returning the results.
msToCollectForNewMaximum number of std::chrono::milliseconds to wait for Objects before returning the results.
filteringFunctionNewA filter function to apply to new Objects, where returning "true" from the function results in a Object being stored.
Returns
A ObjectCollectorReturnData structure.

Definition at line 1487 of file Utilities.hpp.


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