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

Object collector, for collecting objects from a channel. More...

#include <MessageEntities.hpp>

Public Member Functions

co_routine< object_collector_return_data, false > collectObjects (int32_t quantityToCollect, int32_t msToCollectForNew, object_filter< value_type > filteringFunctionNew)
 Begin waiting for objects. More...
 

Member Function Documentation

◆ collectObjects()

template<typename value_type >
co_routine< object_collector_return_data, false > discord_core_api::object_collector< value_type >::collectObjects ( int32_t  quantityToCollect,
int32_t  msToCollectForNew,
object_filter< value_type >  filteringFunctionNew 
)
Parameters
quantityToCollectmaximum quantity of objects to collect before returning the results.
msToCollectForNewmaximum number of 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 object_collector_return_data structure.

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