-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassdpp_1_1channel__collector.html
510 lines (482 loc) · 34.5 KB
/
classdpp_1_1channel__collector.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8">
<meta property="og:title" content="dpp::channel_collector Class Reference - D++ - The lightweight C++ Discord API Library">
<meta property="og:description" content="A lightweight C++ Discord API library supporting the entire Discord API, including Slash Commands, Voice/Audio, Sharding, Clustering and more!">
<meta name="description" content="dpp::channel_collector Class Reference - D++ - A lightweight C++ Discord API library supporting the entire Discord API, including Slash Commands, Voice/Audio, Sharding, Clustering and more!">
<meta property="og:image" content="https://dpp.dev/DPP-Logo.png">
<meta property="og:url" content="https://dpp.dev/">
<meta property="og:type" content="website">
<meta property="twitter:title" content="dpp::channel_collector Class Reference - D++ - The lightweight C++ Discord API Library">
<title>dpp::channel_collector Class Reference - D++ - The lightweight C++ Discord API Library</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="style.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<script>
setTimeout(function() {
$("#main-menu").html($("#main-menu").html() + "<li><select name='vsv' onchange='window.location.href=this.options[this.selectedIndex].value'><option value='/'>master</option><option value='/10.0.35/'>10.0.35</option><option value='/10.0.34/'>10.0.34</option><option value='/10.0.33/'>10.0.33</option><option value='/10.0.32/'>10.0.32</option><option value='/10.0.31/'>10.0.31</option><option value='/10.0.30/'>10.0.30</option><option value='/10.0.29/'>10.0.29</option><option value='/10.0.28/'>10.0.28</option><option value='/10.0.27/'>10.0.27</option><option value='/10.0.26/'>10.0.26</option><option value='/10.0.25/'>10.0.25</option><option value='/10.0.24/'>10.0.24</option><option value='/10.0.23/'>10.0.23</option><option value='/10.0.22/'>10.0.22</option><option value='/10.0.21/'>10.0.21</option><option value='/10.0.20/'>10.0.20</option><option value='/10.0.19/'>10.0.19</option><option value='/10.0.18/'>10.0.18</option><option value='/10.0.17/'>10.0.17</option><option value='/10.0.16/'>10.0.16</option><option value='/10.0.15/'>10.0.15</option><option value='/10.0.14/'>10.0.14</option><option value='/10.0.13/'>10.0.13</option><option value='/10.0.12/'>10.0.12</option><option value='/10.0.11/'>10.0.11</option><option value='/10.0.10/'>10.0.10</option><option value='/10.0.9/'>10.0.9</option><option value='/10.0.8/'>10.0.8</option><option value='/10.0.7/'>10.0.7</option><option value='/10.0.6/'>10.0.6</option><option value='/10.0.5/'>10.0.5</option><option value='/10.0.4/'>10.0.4</option><option value='/10.0.3/'>10.0.3</option><option value='/10.0.2/'>10.0.2</option><option value='/10.0.1/'>10.0.1</option><option value='/10.0.0/'>10.0.0</option><option value='/9.0.19/'>9.0.19</option><option value='/9.0.18/'>9.0.18</option><option value='/9.0.17/'>9.0.17</option><option value='/9.0.16/'>9.0.16</option><option value='/9.0.15/'>9.0.15</option><option value='/9.0.14/'>9.0.14</option><option value='/9.0.13/'>9.0.13</option><option value='/9.0.12/'>9.0.12</option><option value='/9.0.11/'>9.0.11</option><option value='/9.0.10/'>9.0.10</option><option value='/9.0.9/'>9.0.9</option><option value='/9.0.8/'>9.0.8</option><option value='/9.0.7/'>9.0.7</option><option value='/9.0.6/'>9.0.6</option><option value='/9.0.5/'>9.0.5</option><option value='/9.0.4/'>9.0.4</option><option value='/9.0.3/'>9.0.3</option><option value='/9.0.2/'>9.0.2</option><option value='/9.0.1/'>9.0.1</option><option value='/9.0.0/'>9.0.0</option><option value='/1.0.2/'>1.0.2</option><option value='/1.0.1/'>1.0.1</option><option value='/1.0.0/'>1.0.0</option></select></li>");
}, 500);
</script>
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr>
<td id="projectlogo"><img alt="Logo" src="DPP-Logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">D++ (DPP)
</div>
<div id="projectbrief">C++ Discord API Bot Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<label for="MSearchField" style="display: none">Search</label>
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classdpp_1_1channel__collector.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classdpp_1_1channel__collector-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">dpp::channel_collector Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Channel collector. Collects channels during a set timeframe and returns them in a list via the <a class="el" href="classdpp_1_1channel__collector.html#aac2027a7fa0c1f07dd1239ad93be7abc" title="Return the completed collection.">completed()</a> method.
<a href="classdpp_1_1channel__collector.html#details">More...</a></p>
<p><code>#include <collector.h></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for dpp::channel_collector:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classdpp_1_1channel__collector__inherit__graph.svg" width="179" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for dpp::channel_collector:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classdpp_1_1channel__collector__coll__graph.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a371b2baa1fa6a3bfaba6057247baa8cd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdpp_1_1channel__collector.html#a371b2baa1fa6a3bfaba6057247baa8cd">channel_collector</a> (<a class="el" href="classdpp_1_1cluster.html">cluster</a> *cl, uint64_t duration)</td></tr>
<tr class="memdesc:a371b2baa1fa6a3bfaba6057247baa8cd"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new channel collector object. <a href="classdpp_1_1channel__collector.html#a371b2baa1fa6a3bfaba6057247baa8cd">More...</a><br /></td></tr>
<tr class="separator:a371b2baa1fa6a3bfaba6057247baa8cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac2027a7fa0c1f07dd1239ad93be7abc"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdpp_1_1channel__collector.html#aac2027a7fa0c1f07dd1239ad93be7abc">completed</a> (const std::vector< <a class="el" href="classdpp_1_1channel.html">dpp::channel</a> > &list)=0</td></tr>
<tr class="memdesc:aac2027a7fa0c1f07dd1239ad93be7abc"><td class="mdescLeft"> </td><td class="mdescRight">Return the completed collection. <a href="classdpp_1_1channel__collector.html#aac2027a7fa0c1f07dd1239ad93be7abc">More...</a><br /></td></tr>
<tr class="separator:aac2027a7fa0c1f07dd1239ad93be7abc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac048b6f35cb511cc9b8d46b1591b243e"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classdpp_1_1channel.html">dpp::channel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdpp_1_1channel__collector.html#ac048b6f35cb511cc9b8d46b1591b243e">filter</a> (const <a class="el" href="structdpp_1_1channel__create__t.html">dpp::channel_create_t</a> &element)</td></tr>
<tr class="memdesc:ac048b6f35cb511cc9b8d46b1591b243e"><td class="mdescLeft"> </td><td class="mdescRight">Select and filter the items which are to appear in the list This is called every time a new event is fired, to filter the event and determine which of the items is sent to the list. Returning nullptr excludes the item from the list. <a href="classdpp_1_1channel__collector.html#ac048b6f35cb511cc9b8d46b1591b243e">More...</a><br /></td></tr>
<tr class="separator:ac048b6f35cb511cc9b8d46b1591b243e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f861f292f5f844328405d3300f122ca"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdpp_1_1channel__collector.html#a4f861f292f5f844328405d3300f122ca">~channel_collector</a> ()=default</td></tr>
<tr class="memdesc:a4f861f292f5f844328405d3300f122ca"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the channel collector object. <a href="classdpp_1_1channel__collector.html#a4f861f292f5f844328405d3300f122ca">More...</a><br /></td></tr>
<tr class="separator:a4f861f292f5f844328405d3300f122ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6172faa2391a90cfaa11ca76ec95258"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdpp_1_1collector.html#ad6172faa2391a90cfaa11ca76ec95258">completed</a> (const std::vector< C > &list)=0</td></tr>
<tr class="memdesc:ad6172faa2391a90cfaa11ca76ec95258"><td class="mdescLeft"> </td><td class="mdescRight">You must implement this function to receive the completed list of captured objects. <a href="classdpp_1_1collector.html#ad6172faa2391a90cfaa11ca76ec95258">More...</a><br /></td></tr>
<tr class="separator:ad6172faa2391a90cfaa11ca76ec95258"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe7a5ff238f82ee08003051468626c15"><td class="memItemLeft" align="right" valign="top">virtual const C * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdpp_1_1collector.html#abe7a5ff238f82ee08003051468626c15">filter</a> (const T &element)=0</td></tr>
<tr class="memdesc:abe7a5ff238f82ee08003051468626c15"><td class="mdescLeft"> </td><td class="mdescRight">Filter the list of elements. <a href="classdpp_1_1collector.html#abe7a5ff238f82ee08003051468626c15">More...</a><br /></td></tr>
<tr class="separator:abe7a5ff238f82ee08003051468626c15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaaff21b83581001598be2610469ccd4b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdpp_1_1collector.html#aaaff21b83581001598be2610469ccd4b">cancel</a> ()</td></tr>
<tr class="memdesc:aaaff21b83581001598be2610469ccd4b"><td class="mdescLeft"> </td><td class="mdescRight">Immediately cancels the collector. <a href="classdpp_1_1collector.html#aaaff21b83581001598be2610469ccd4b">More...</a><br /></td></tr>
<tr class="separator:aaaff21b83581001598be2610469ccd4b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:af7f9cfbcf647292a6eff59c63508171b"><td class="memItemLeft" align="right" valign="top">class <a class="el" href="classdpp_1_1cluster.html">cluster</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdpp_1_1collector.html#af7f9cfbcf647292a6eff59c63508171b">owner</a></td></tr>
<tr class="memdesc:af7f9cfbcf647292a6eff59c63508171b"><td class="mdescLeft"> </td><td class="mdescRight">Owning cluster. <a href="classdpp_1_1collector.html#af7f9cfbcf647292a6eff59c63508171b">More...</a><br /></td></tr>
<tr class="separator:af7f9cfbcf647292a6eff59c63508171b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Channel collector. Collects channels during a set timeframe and returns them in a list via the <a class="el" href="classdpp_1_1channel__collector.html#aac2027a7fa0c1f07dd1239ad93be7abc" title="Return the completed collection.">completed()</a> method. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a371b2baa1fa6a3bfaba6057247baa8cd" name="a371b2baa1fa6a3bfaba6057247baa8cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a371b2baa1fa6a3bfaba6057247baa8cd">◆ </a></span>channel_collector()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dpp::channel_collector::channel_collector </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdpp_1_1cluster.html">cluster</a> * </td>
<td class="paramname"><em>cl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>duration</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new channel collector object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cl</td><td>cluster to associate the collector with </td></tr>
<tr><td class="paramname">duration</td><td>Duration of time to run the collector for in seconds </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4f861f292f5f844328405d3300f122ca" name="a4f861f292f5f844328405d3300f122ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f861f292f5f844328405d3300f122ca">◆ </a></span>~channel_collector()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual dpp::channel_collector::~channel_collector </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the channel collector object. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aaaff21b83581001598be2610469ccd4b" name="aaaff21b83581001598be2610469ccd4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaaff21b83581001598be2610469ccd4b">◆ </a></span>cancel()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , class C > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classdpp_1_1collector.html">dpp::collector</a>< T, C >::cancel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Immediately cancels the collector. </p>
<p >Use this if you have met the conditions for which you are collecting objects early, e.g. you were watching for a message containing 'yes' or 'no' and have received it before the time is up.</p>
<dl class="section note"><dt>Note</dt><dd>Causes calling of the <a class="el" href="classdpp_1_1channel__collector.html#aac2027a7fa0c1f07dd1239ad93be7abc" title="Return the completed collection.">completed()</a> method if it has not yet been called. </dd></dl>
</div>
</div>
<a id="ad6172faa2391a90cfaa11ca76ec95258" name="ad6172faa2391a90cfaa11ca76ec95258"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6172faa2391a90cfaa11ca76ec95258">◆ </a></span>completed() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , class C > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classdpp_1_1collector.html">dpp::collector</a>< T, C >::completed </td>
<td>(</td>
<td class="paramtype">const std::vector< C > & </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>You must implement this function to receive the completed list of captured objects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>The list of captured objects in captured order </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aac2027a7fa0c1f07dd1239ad93be7abc" name="aac2027a7fa0c1f07dd1239ad93be7abc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac2027a7fa0c1f07dd1239ad93be7abc">◆ </a></span>completed() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void dpp::channel_collector::completed </td>
<td>(</td>
<td class="paramtype">const std::vector< <a class="el" href="classdpp_1_1channel.html">dpp::channel</a> > & </td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the completed collection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>items collected during the timeframe specified </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac048b6f35cb511cc9b8d46b1591b243e" name="ac048b6f35cb511cc9b8d46b1591b243e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac048b6f35cb511cc9b8d46b1591b243e">◆ </a></span>filter() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classdpp_1_1channel.html">dpp::channel</a> * dpp::channel_collector::filter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structdpp_1_1channel__create__t.html">dpp::channel_create_t</a> & </td>
<td class="paramname"><em>element</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Select and filter the items which are to appear in the list This is called every time a new event is fired, to filter the event and determine which of the items is sent to the list. Returning nullptr excludes the item from the list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">element</td><td>element to filter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returned item to add to the list, or nullptr to skip adding this element </dd></dl>
</div>
</div>
<a id="abe7a5ff238f82ee08003051468626c15" name="abe7a5ff238f82ee08003051468626c15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe7a5ff238f82ee08003051468626c15">◆ </a></span>filter() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , class C > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const C * <a class="el" href="classdpp_1_1collector.html">dpp::collector</a>< T, C >::filter </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>element</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Filter the list of elements. </p>
<p >Every time an event is fired on the collector, this method wil be called to determine if we should add an object to the list or not. This function can then process the <code>element</code> value, extract the parts which are to be saved to a list (e.g. a <a class="el" href="structdpp_1_1message.html" title="Represents messages sent and received on Discord.">dpp::message</a> out of a <a class="el" href="structdpp_1_1message__create__t.html" title="Create message.">dpp::message_create_t</a>) and return it as the return value. Returning a value of nullptr causes no object to be stored.</p>
<p >Here is an example of how to filter messages which have specific text in them. This should be used with the specialised type <a class="el" href="classdpp_1_1message__collector.html" title="Message collector. Collects messages during a set timeframe and returns them in a list via the comple...">dpp::message_collector</a></p>
<div class="fragment"><div class="line"><span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code hl_struct" href="structdpp_1_1message.html">dpp::message</a>* <a class="code hl_function" href="classdpp_1_1channel__collector.html#ac048b6f35cb511cc9b8d46b1591b243e">filter</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structdpp_1_1message__create__t.html">dpp::message_create_t</a>& m) {</div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_variable" href="namespacedpp_1_1unicode__emoji.html#a24ac871c89f4e1779cfeda23077faeac">m</a>.msg.content.find(<span class="stringliteral">"something i want"</span>) != std::string::npos) {</div>
<div class="line"> <span class="keywordflow">return</span> &<a class="code hl_variable" href="namespacedpp_1_1unicode__emoji.html#a24ac871c89f4e1779cfeda23077faeac">m</a>.msg;</div>
<div class="line"> } <span class="keywordflow">else</span> {</div>
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="ttc" id="aclassdpp_1_1channel__collector_html_ac048b6f35cb511cc9b8d46b1591b243e"><div class="ttname"><a href="classdpp_1_1channel__collector.html#ac048b6f35cb511cc9b8d46b1591b243e">dpp::channel_collector::filter</a></div><div class="ttdeci">virtual const dpp::channel * filter(const dpp::channel_create_t &element)</div><div class="ttdoc">Select and filter the items which are to appear in the list This is called every time a new event is ...</div><div class="ttdef"><b>Definition:</b> collector.h:354</div></div>
<div class="ttc" id="anamespacedpp_1_1unicode__emoji_html_a24ac871c89f4e1779cfeda23077faeac"><div class="ttname"><a href="namespacedpp_1_1unicode__emoji.html#a24ac871c89f4e1779cfeda23077faeac">dpp::unicode_emoji::m</a></div><div class="ttdeci">constexpr const char m[]</div><div class="ttdef"><b>Definition:</b> unicode_emoji.h:5304</div></div>
<div class="ttc" id="astructdpp_1_1message__create__t_html"><div class="ttname"><a href="structdpp_1_1message__create__t.html">dpp::message_create_t</a></div><div class="ttdoc">Create message.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:1645</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2071</div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">element</td><td>The event data to filter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>const C* Returned object or nullptr </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af7f9cfbcf647292a6eff59c63508171b" name="af7f9cfbcf647292a6eff59c63508171b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7f9cfbcf647292a6eff59c63508171b">◆ </a></span>owner</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T , class C > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">class <a class="el" href="classdpp_1_1cluster.html">cluster</a>* <a class="el" href="classdpp_1_1collector.html">dpp::collector</a>< T, C >::owner</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Owning cluster. </p>
</div>
</div>
</div><!-- contents --><script src="https://giscus.app/client.js" data-repo="brainboxdotcc/dpp-comments" data-repo-id="R_kgDOHOY4xg" data-category="General" data-category-id="DIC_kwDOHOY4xs4CRYtj" data-mapping="pathname" data-strict="1" data-reactions-enabled="1" data-emit-metadata="1" data-input-position="top" data-theme="preferred_color_scheme" data-lang="en" data-loading="lazy" crossorigin="anonymous" async></script>
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacedpp.html">dpp</a></li><li class="navelem"><a class="el" href="classdpp_1_1channel__collector.html">channel_collector</a></li>
</ul>
</div>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-QTH6YHBNG5"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/styles/base16/dracula.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlightjs-line-numbers.js/2.8.0/highlightjs-line-numbers.min.js"></script>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@100&display=swap" rel="stylesheet">
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-QTH6YHBNG5');
$(function() {
$(".fragment").each(function(i,node) {
var $node = $(node);
$node.children(":not(.line)").remove();
$node.html("<pre><code class='stan'>" + $node.text().trim().replaceAll("<", "<").replaceAll(">", ">") + "</code></pre>");
hljs.configure({
languages: ['cpp','diff','cmake','bash','sh','text'],
ignoreUnescapedHTML: true
});
hljs.highlightAll(node);
hljs.initLineNumbersOnLoad(node);
});
$(".fragment").parent().parent().parent().parent().removeClass('doxtable');
});
</script>
<style>
.hljs-ln-code, code, code a, pre.fragment, div.fragment, div.fragment .line, div.fragment span, div.fragment .line a, div.fragment .line span {
font-family: 'JetBrains Mono', monospace !important;
font-size: 0.8rem !important;
}
.fragment {
padding: 0 !important;
margin-top: 0 !important;
margin-bottom: 0 !important;
background: none !important;
border: 0 !important;
}
.hljs-ln-n::before {
content: attr(data-line-number);
padding-right: 1rem !important;
}
table.markdownTable code td, table.markdownTable code th, table.fieldtable code td, table.fieldtable code th, table.doxtable code td, table.doxtable code th {
border: 0 !important;
padding: 0 !important;
}
</style>
<div style="z-index: -9999; position: absolute; right: 0; top: 0; font-size: 0.0001rem;color:transparent;background:none">
<!-- For crawlability of past versions -->
<a href='/10.0.35/'>D++ Library version 10.0.35</a><a href='/10.0.34/'>D++ Library version 10.0.34</a><a href='/10.0.33/'>D++ Library version 10.0.33</a><a href='/10.0.32/'>D++ Library version 10.0.32</a><a href='/10.0.31/'>D++ Library version 10.0.31</a><a href='/10.0.30/'>D++ Library version 10.0.30</a><a href='/10.0.29/'>D++ Library version 10.0.29</a><a href='/10.0.28/'>D++ Library version 10.0.28</a><a href='/10.0.27/'>D++ Library version 10.0.27</a><a href='/10.0.26/'>D++ Library version 10.0.26</a><a href='/10.0.25/'>D++ Library version 10.0.25</a><a href='/10.0.24/'>D++ Library version 10.0.24</a><a href='/10.0.23/'>D++ Library version 10.0.23</a><a href='/10.0.22/'>D++ Library version 10.0.22</a><a href='/10.0.21/'>D++ Library version 10.0.21</a><a href='/10.0.20/'>D++ Library version 10.0.20</a><a href='/10.0.19/'>D++ Library version 10.0.19</a><a href='/10.0.18/'>D++ Library version 10.0.18</a><a href='/10.0.17/'>D++ Library version 10.0.17</a><a href='/10.0.16/'>D++ Library version 10.0.16</a><a href='/10.0.15/'>D++ Library version 10.0.15</a><a href='/10.0.14/'>D++ Library version 10.0.14</a><a href='/10.0.13/'>D++ Library version 10.0.13</a><a href='/10.0.12/'>D++ Library version 10.0.12</a><a href='/10.0.11/'>D++ Library version 10.0.11</a><a href='/10.0.10/'>D++ Library version 10.0.10</a><a href='/10.0.9/'>D++ Library version 10.0.9</a><a href='/10.0.8/'>D++ Library version 10.0.8</a><a href='/10.0.7/'>D++ Library version 10.0.7</a><a href='/10.0.6/'>D++ Library version 10.0.6</a><a href='/10.0.5/'>D++ Library version 10.0.5</a><a href='/10.0.4/'>D++ Library version 10.0.4</a><a href='/10.0.3/'>D++ Library version 10.0.3</a><a href='/10.0.2/'>D++ Library version 10.0.2</a><a href='/10.0.1/'>D++ Library version 10.0.1</a><a href='/10.0.0/'>D++ Library version 10.0.0</a><a href='/9.0.19/'>D++ Library version 9.0.19</a><a href='/9.0.18/'>D++ Library version 9.0.18</a><a href='/9.0.17/'>D++ Library version 9.0.17</a><a href='/9.0.16/'>D++ Library version 9.0.16</a><a href='/9.0.15/'>D++ Library version 9.0.15</a><a href='/9.0.14/'>D++ Library version 9.0.14</a><a href='/9.0.13/'>D++ Library version 9.0.13</a><a href='/9.0.12/'>D++ Library version 9.0.12</a><a href='/9.0.11/'>D++ Library version 9.0.11</a><a href='/9.0.10/'>D++ Library version 9.0.10</a><a href='/9.0.9/'>D++ Library version 9.0.9</a><a href='/9.0.8/'>D++ Library version 9.0.8</a><a href='/9.0.7/'>D++ Library version 9.0.7</a><a href='/9.0.6/'>D++ Library version 9.0.6</a><a href='/9.0.5/'>D++ Library version 9.0.5</a><a href='/9.0.4/'>D++ Library version 9.0.4</a><a href='/9.0.3/'>D++ Library version 9.0.3</a><a href='/9.0.2/'>D++ Library version 9.0.2</a><a href='/9.0.1/'>D++ Library version 9.0.1</a><a href='/9.0.0/'>D++ Library version 9.0.0</a><a href='/1.0.2/'>D++ Library version 1.0.2</a><a href='/1.0.1/'>D++ Library version 1.0.1</a><a href='/1.0.0/'>D++ Library version 1.0.0</a>
</div>
</body>
</html>