-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDisCatSharp.Interactivity.xml
More file actions
2256 lines (2256 loc) · 131 KB
/
DisCatSharp.Interactivity.xml
File metadata and controls
2256 lines (2256 loc) · 131 KB
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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>DisCatSharp.Interactivity</name>
</assembly>
<members>
<member name="T:DisCatSharp.Interactivity.Entities.ModalPage">
<summary>
A modal page.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.Entities.ModalPage.#ctor(DisCatSharp.Entities.DiscordInteractionModalBuilder,DisCatSharp.Entities.DiscordButtonComponent,System.String)">
<summary>
Creates a new modal page for the paginated modal builder.
</summary>
<param name="modal">The modal to display.</param>
<param name="openButton">The button to display to open the current page. This is skipped if possible.</param>
<param name="openText">The text to display to open the current page. This is skipped if possible.</param>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.ModalPage.Modal">
<summary>
The modal that will be displayed.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.ModalPage.OpenButton">
<summary>
The button that will be displayed on the ephemeral message.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.ModalPage.OpenMessage">
<summary>
The ephemeral message to display for this page.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.Entities.Page">
<summary>
The page.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.Page.UsesCV2">
<summary>
Gets a value indicating whether the CV2 feature is used.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.Entities.Page.#ctor(System.String,DisCatSharp.Entities.DiscordEmbedBuilder)">
<summary>
<para>Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.Entities.Page" /> class.</para>
<para>You need to specify at least <paramref name="content" /> or <paramref name="embed" /> or both.</para>
</summary>
<param name="content">The content.</param>
<param name="embed">The embed.</param>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.Page.Content">
<summary>
Gets or sets the content.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.Entities.Page.WithContent(System.String)">
<summary>
Sets the content of the page.
<note type="warning">This cannot be used together with <see cref="M:DisCatSharp.Interactivity.Entities.Page.AddComponents(DisCatSharp.Entities.DiscordComponent[])"/> / <see cref="M:DisCatSharp.Interactivity.Entities.Page.AddComponents(System.Collections.Generic.IEnumerable{DisCatSharp.Entities.DiscordComponent})"/>.</note>
</summary>
<param name="content">The new content to assign to the page.</param>
<returns>The current <see cref="T:DisCatSharp.Interactivity.Entities.Page"/> instance with updated content.</returns>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.Page.Embed">
<summary>
Gets or sets the embed.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.Entities.Page.WithEmbed(DisCatSharp.Entities.DiscordEmbedBuilder)">
<summary>
Sets the embed of the page.
<note type="warning">This cannot be used together with <see cref="M:DisCatSharp.Interactivity.Entities.Page.AddComponents(DisCatSharp.Entities.DiscordComponent[])"/> / <see cref="M:DisCatSharp.Interactivity.Entities.Page.AddComponents(System.Collections.Generic.IEnumerable{DisCatSharp.Entities.DiscordComponent})"/>.</note>
</summary>
<param name="embedBuilder">The builder used to construct the embed to add to the page.</param>
<returns>The current <see cref="T:DisCatSharp.Interactivity.Entities.Page"/> instance with the embed applied.</returns>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.Page.FilesInternal">
<summary>
The files of this page.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.Page.ComponentsInternal">
<summary>
The components of this page.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.Entities.Page.AddFile(System.String,System.IO.Stream,System.Boolean,System.String)">
<summary>
Adds a file to the page.
</summary>
<param name="filename">Name of the file.</param>
<param name="data">File data.</param>
<param name="resetStreamPosition">
Tells the API Client to reset the stream position to what it was after the file is
sent.
</param>
<param name="description">Description of the file.</param>
</member>
<member name="M:DisCatSharp.Interactivity.Entities.Page.AddComponents(DisCatSharp.Entities.DiscordComponent[])">
<summary>
Adds v2 components to the message. This enables the use of up to <c>40</c> components per message.
<note type="warning">This does not support old component behavior. Only V2.</note>
</summary>
<param name="components">The components to add to the page.</param>
<returns>The current page to be chained.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.Entities.Page.AddComponents(System.Collections.Generic.IEnumerable{DisCatSharp.Entities.DiscordComponent})">
<summary>
Adds v2 components to the message. This enables the use of up to <c>40</c> components per message.
<note type="warning">This does not support old component behavior. Only V2.</note>
</summary>
<param name="components">The components to add to the page.</param>
<returns>The current page to be chained.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">No components were passed.</exception>
<returns>The current page to be chained.</returns>
</member>
<member name="T:DisCatSharp.Interactivity.Entities.PaginatedModalResponse">
<summary>
A response from the paginated modal response
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.PaginatedModalResponse.Responses">
<summary>
The responses. The key is the customid of each component.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.PaginatedModalResponse.SelectResponses">
<summary>
The select menu responses. The key is the customid of each component.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.PaginatedModalResponse.Interaction">
<summary>
The last interaction. This is automatically replied to with a ephemeral "thinking" state. Use
EditOriginalResponseAsync to modify this.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.PaginatedModalResponse.TimedOut">
<summary>
Whether the interaction timed out.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.Entities.PaginationEmojis">
<summary>
The pagination emojis.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.PaginationEmojis.Left">
<summary>
Gets or sets the left emoji.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.PaginationEmojis.Right">
<summary>
Gets or sets the right emoji.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.PaginationEmojis.SkipLeft">
<summary>
Gets or sets the skip left emoji.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.PaginationEmojis.SkipRight">
<summary>
Gets or sets the skip right emoji.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.Entities.PaginationEmojis.Stop">
<summary>
Gets or sets the stop emoji.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.Entities.PaginationEmojis.#ctor">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.Entities.PaginationEmojis" /> class.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.Enums.ButtonPaginationBehavior">
<summary>
Represents options of how to handle pagination timing out.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.ButtonPaginationBehavior.Disable">
<summary>
The buttons should be disabled when pagination times out.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.ButtonPaginationBehavior.Ignore">
<summary>
The buttons should be left as is when pagination times out.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.ButtonPaginationBehavior.DeleteMessage">
<summary>
The entire message should be deleted when pagination times out.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.ButtonPaginationBehavior.DeleteButtons">
<summary>
The buttons should be removed entirely when pagination times out.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.Enums.InteractionResponseBehavior">
<summary>
The interaction response behavior.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.InteractionResponseBehavior.Ignore">
<summary>
Indicates that invalid input should be ignored when waiting for interactions. This will cause the interaction to
fail.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.InteractionResponseBehavior.Ack">
<summary>
Indicates that invalid input should be ACK'd. The interaction will succeed, but nothing will happen.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.InteractionResponseBehavior.Respond">
<summary>
Indicates that invalid input should warrant an ephemeral error message.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.Enums.PaginationBehaviour">
<summary>
Specifies how pagination will handle advancing past the first and last pages.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.PaginationBehaviour.WrapAround">
<summary>
Going forward beyond the last page will loop back to the first page.
Likewise, going back from the first page will loop around to the last page.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.PaginationBehaviour.Ignore">
<summary>
Attempting to go beyond the first or last page will be ignored.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.Enums.PaginationDeletion">
<summary>
Specifies what should be done once pagination times out.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.PaginationDeletion.DeleteEmojis">
<summary>
Reaction emojis will be deleted on timeout.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.PaginationDeletion.KeepEmojis">
<summary>
Reaction emojis will not be deleted on timeout.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.PaginationDeletion.DeleteMessage">
<summary>
The message will be completely deleted on timeout.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.Enums.PollBehaviour">
<summary>
Specifies what should be done when a poll times out.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.PollBehaviour.KeepEmojis">
<summary>
Reaction emojis will not be deleted.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.PollBehaviour.DeleteEmojis">
<summary>
Reaction emojis will be deleted.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.Enums.SplitType">
<summary>
Specifies how to split a string.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.SplitType.Character">
<summary>
Splits string per 500 characters.
</summary>
</member>
<member name="F:DisCatSharp.Interactivity.Enums.SplitType.Line">
<summary>
Splits string per 15 lines.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.ComponentEventWaiter">
<summary>
A component-based version of <see cref="T:DisCatSharp.Interactivity.EventHandling.EventWaiter`1" />
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentEventWaiter.#ctor(DisCatSharp.DiscordClient,DisCatSharp.Interactivity.InteractivityConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.ComponentEventWaiter" /> class.
</summary>
<param name="client">The client.</param>
<param name="config">The config.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentEventWaiter.Dispose">
<summary>
Disposes the waiter.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentEventWaiter.WaitForMatchAsync(DisCatSharp.Interactivity.EventHandling.ComponentMatchRequest)">
<summary>
Waits for a specified <see cref="T:DisCatSharp.Interactivity.EventHandling.ComponentMatchRequest" />'s predicate to be fulfilled.
</summary>
<param name="request">The request to wait for.</param>
<returns>The returned args, or null if it timed out.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentEventWaiter.CollectMatchesAsync(DisCatSharp.Interactivity.EventHandling.ComponentCollectRequest)">
<summary>
Collects reactions and returns the result when the <see cref="T:DisCatSharp.Interactivity.EventHandling.ComponentMatchRequest" />'s cancellation token is
canceled.
</summary>
<param name="request">The request to wait on.</param>
<returns>The result from request's predicate over the period of time leading up to the token's cancellation.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentEventWaiter.Handle(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.ComponentInteractionCreateEventArgs)">
<summary>
Handles the waiter.
</summary>
<param name="_">The client.</param>
<param name="args">The args.</param>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.ComponentPaginator">
<summary>
The component paginator.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentPaginator.#ctor(DisCatSharp.DiscordClient,DisCatSharp.Interactivity.InteractivityConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.ComponentPaginator" /> class.
</summary>
<param name="client">The client.</param>
<param name="config">The config.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentPaginator.DoPaginationAsync(DisCatSharp.Interactivity.EventHandling.IPaginationRequest)">
<summary>
Does the pagination async.
</summary>
<param name="request">The request.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentPaginator.Dispose">
<summary>
Disposes the paginator.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentPaginator.Handle(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.ComponentInteractionCreateEventArgs)">
<summary>
Handles the pagination event.
</summary>
<param name="_">The client.</param>
<param name="e">The event arguments.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentPaginator.HandlePaginationAsync(DisCatSharp.Interactivity.EventHandling.IPaginationRequest,DisCatSharp.EventArgs.ComponentInteractionCreateEventArgs)">
<summary>
Handles the pagination async.
</summary>
<param name="request">The request.</param>
<param name="args">The arguments.</param>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.ModalEventWaiter">
<summary>
A modal-based version of <see cref="T:DisCatSharp.Interactivity.EventHandling.EventWaiter`1" />
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ModalEventWaiter.#ctor(DisCatSharp.DiscordClient,DisCatSharp.Interactivity.InteractivityConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.ComponentEventWaiter" /> class.
</summary>
<param name="client">The client.</param>
<param name="config">The config.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ModalEventWaiter.Dispose">
<summary>
Disposes the waiter.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ModalEventWaiter.WaitForModalMatchAsync(DisCatSharp.Interactivity.EventHandling.ModalMatchRequest)">
<summary>
Waits for a specified <see cref="T:DisCatSharp.Interactivity.EventHandling.ModalMatchRequest" />'s predicate to be fulfilled.
</summary>
<param name="request">The request to wait for.</param>
<returns>The returned args, or null if it timed out.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ModalEventWaiter.Handle(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.ComponentInteractionCreateEventArgs)">
<summary>
Handles the waiter.
</summary>
<param name="_">The client.</param>
<param name="args">The args.</param>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.PaginationButtons">
<summary>
The pagination buttons.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.PaginationButtons.#ctor">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.PaginationButtons" /> class.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.PaginationButtons.#ctor(DisCatSharp.Interactivity.EventHandling.PaginationButtons)">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.PaginationButtons" /> class.
</summary>
<param name="other">The other <see cref="T:DisCatSharp.Interactivity.EventHandling.PaginationButtons" />.</param>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.PaginationButtons.SkipLeft">
<summary>
Gets or sets the skip left button.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.PaginationButtons.Left">
<summary>
Gets or sets the left button.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.PaginationButtons.Stop">
<summary>
Gets or sets the stop button.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.PaginationButtons.Right">
<summary>
Gets or sets the right button.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.PaginationButtons.SkipRight">
<summary>
Gets or sets the skip right button.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.PaginationButtons.ButtonArray">
<summary>
Gets the button array.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest">
<summary>
The button pagination request.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.#ctor(DisCatSharp.Entities.DiscordMessage,DisCatSharp.Entities.DiscordUser,DisCatSharp.Interactivity.Enums.PaginationBehaviour,DisCatSharp.Interactivity.Enums.ButtonPaginationBehavior,DisCatSharp.Interactivity.EventHandling.PaginationButtons,System.Collections.Generic.IEnumerable{DisCatSharp.Interactivity.Entities.Page},System.Threading.CancellationToken)">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest" /> class.
</summary>
<param name="message">The message.</param>
<param name="user">The user.</param>
<param name="behavior">The behavior.</param>
<param name="buttonBehavior">The button behavior.</param>
<param name="buttons">The buttons.</param>
<param name="pages">The pages.</param>
<param name="token">The token.</param>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.PageCount">
<summary>
Gets the page count.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.GetPageAsync">
<summary>
Gets the page.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.SkipLeftAsync">
<summary>
Skips the left.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.SkipRightAsync">
<summary>
Skips the right.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.NextPageAsync">
<summary>
Gets the next page.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.PreviousPageAsync">
<summary>
Gets the previous page.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.GetEmojisAsync">
<summary>
Gets the emojis.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.GetButtonsAsync">
<summary>
Gets the buttons.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.GetMessageAsync">
<summary>
Gets the message.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.GetUserAsync">
<summary>
Gets the user.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.GetTaskCompletionSourceAsync">
<summary>
Gets the task completion source.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ButtonPaginationRequest.DoCleanupAsync">
<summary>
Does the cleanup.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.ComponentCollectRequest">
<summary>
Represents a component event that is being waited for.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentCollectRequest.#ctor(DisCatSharp.Entities.DiscordMessage,System.Func{DisCatSharp.EventArgs.ComponentInteractionCreateEventArgs,System.Boolean},System.Threading.CancellationToken)">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.ComponentCollectRequest" /> class.
</summary>
<param name="message"></param>
<param name="predicate">The predicate.</param>
<param name="cancellation">The cancellation token.</param>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.ComponentCollectRequest.Collected">
<summary>
Gets the collected.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.ComponentMatchRequest">
<summary>
Represents a match that is being waited for.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentMatchRequest.#ctor(DisCatSharp.Entities.DiscordMessage,System.Func{DisCatSharp.EventArgs.ComponentInteractionCreateEventArgs,System.Boolean},System.Threading.CancellationToken)">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.ComponentMatchRequest" /> class.
</summary>
<param name="message">The message.</param>
<param name="predicate">The predicate.</param>
<param name="cancellation">The cancellation token.</param>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.ComponentMatchRequest.Message">
<summary>
The id to wait on. This should be uniquely formatted to avoid collisions.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.ComponentMatchRequest.Tcs">
<summary>
The completion source that represents the result of the match.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ComponentMatchRequest.IsMatch(DisCatSharp.EventArgs.ComponentInteractionCreateEventArgs)">
<summary>
Whether it is a match.
</summary>
<param name="args">The arguments.</param>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest">
<summary>
The interaction pagination request.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.#ctor(DisCatSharp.Entities.DiscordInteraction,DisCatSharp.Entities.DiscordMessage,DisCatSharp.Entities.DiscordUser,DisCatSharp.Interactivity.Enums.PaginationBehaviour,DisCatSharp.Interactivity.Enums.ButtonPaginationBehavior,DisCatSharp.Interactivity.EventHandling.PaginationButtons,System.Collections.Generic.IEnumerable{DisCatSharp.Interactivity.Entities.Page},System.Threading.CancellationToken)">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest" /> class.
</summary>
<param name="interaction">The interaction.</param>
<param name="message">The message.</param>
<param name="user">The user.</param>
<param name="behavior">The behavior.</param>
<param name="behaviorBehavior">The behavior behavior.</param>
<param name="buttons">The buttons.</param>
<param name="pages">The pages.</param>
<param name="token">The token.</param>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.PageCount">
<summary>
Gets the page count.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.GetPageAsync">
<summary>
Gets the page.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.SkipLeftAsync">
<summary>
Skips the left page.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.SkipRightAsync">
<summary>
Skips the right page.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.NextPageAsync">
<summary>
Gets the next page.
</summary>
<returns>A Task.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.PreviousPageAsync">
<summary>
Gets the previous page.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.GetEmojisAsync">
<summary>
Gets the emojis.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.GetButtonsAsync">
<summary>
Gets the buttons.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.GetMessageAsync">
<summary>
Gets the message.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.GetUserAsync">
<summary>
Gets the user.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.GetTaskCompletionSourceAsync">
<summary>
Gets the task completion source.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.DoCleanupAsync">
<summary>
Cleanup.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.RegenerateCts(DisCatSharp.Entities.DiscordInteraction)">
<summary>
Regenerates the cts.
</summary>
<param name="interaction">The interaction.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.InteractionPaginationRequest.GetLastInteractionAsync">
<summary>
Gets the message.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.ModalMatchRequest">
<summary>
Represents a match that is being waited for.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ModalMatchRequest.#ctor(System.String,System.Func{DisCatSharp.EventArgs.ComponentInteractionCreateEventArgs,System.Boolean},System.Threading.CancellationToken)">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.ModalMatchRequest" /> class.
</summary>
<param name="customId">The custom id.</param>
<param name="predicate">The predicate.</param>
<param name="cancellation">The cancellation token.</param>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.ModalMatchRequest.CustomId">
<summary>
The id to wait on. This should be uniquely formatted to avoid collisions.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.ModalMatchRequest.Tcs">
<summary>
The completion source that represents the result of the match.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ModalMatchRequest.IsMatch(DisCatSharp.EventArgs.ComponentInteractionCreateEventArgs)">
<summary>
Whether it is a match.
</summary>
<param name="args">The arguments.</param>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.EventWaiter`1">
<summary>
EventWaiter is a class that serves as a layer between the InteractivityExtension
and the DiscordClient to listen to an event and check for matches to a predicate.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.EventWaiter`1.#ctor(DisCatSharp.DiscordClient)">
<summary>
Creates a new EventWaiter object.
</summary>
<param name="client">Your DiscordClient</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.EventWaiter`1.Dispose">
<summary>
Disposes this EventWaiter
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.EventWaiter`1.WaitForMatchAsync(DisCatSharp.Interactivity.EventHandling.MatchRequest{`0})">
<summary>
Waits for a match to a specific request, else returns null.
</summary>
<param name="request">Request to match</param>
<returns></returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.EventWaiter`1.CollectMatchesAsync(DisCatSharp.Interactivity.EventHandling.CollectRequest{`0})">
<summary>
Collects the matches async.
</summary>
<param name="request">The request.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.EventWaiter`1.HandleEvent(DisCatSharp.DiscordClient,`0)">
<summary>
Handles the event.
</summary>
<param name="client">The client.</param>
<param name="eventArgs">The event's arguments.</param>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.IPaginator">
<summary>
The paginator.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.IPaginator.DoPaginationAsync(DisCatSharp.Interactivity.EventHandling.IPaginationRequest)">
<summary>
Paginates.
</summary>
<param name="request">The request to paginate.</param>
<returns>A task that completes when the pagination finishes or times out.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.IPaginator.Dispose">
<summary>
Disposes this EventWaiter
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.Paginator">
<summary>
The paginator.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Paginator.#ctor(DisCatSharp.DiscordClient)">
<summary>
Creates a new EventWaiter object.
</summary>
<param name="client">Discord client</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Paginator.DoPaginationAsync(DisCatSharp.Interactivity.EventHandling.IPaginationRequest)">
<summary>
Dos the pagination async.
</summary>
<param name="request">The request.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Paginator.Dispose">
<summary>
Disposes this EventWaiter
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Paginator.HandleReactionAdd(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.MessageReactionAddEventArgs)">
<summary>
Handles the reaction add.
</summary>
<param name="client">The client.</param>
<param name="eventArgs">The event's arguments.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Paginator.HandleReactionRemove(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.MessageReactionRemoveEventArgs)">
<summary>
Handles the reaction remove.
</summary>
<param name="client">The client.</param>
<param name="eventArgs">The event's arguments.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Paginator.HandleReactionClear(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.MessageReactionsClearEventArgs)">
<summary>
Handles the reaction clear.
</summary>
<param name="client">The client.</param>
<param name="eventArgs">The eventArgs.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Paginator.ResetReactionsAsync(DisCatSharp.Interactivity.EventHandling.IPaginationRequest)">
<summary>
Resets the reactions async.
</summary>
<param name="p">The p.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Paginator.PaginateAsync(DisCatSharp.Interactivity.EventHandling.IPaginationRequest,DisCatSharp.Entities.DiscordEmoji)">
<summary>
Paginates the async.
</summary>
<param name="p">The p.</param>
<param name="emoji">The emoji.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Paginator.Finalize">
<inheritdoc />
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.Poller">
<summary>
The poller.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Poller.#ctor(DisCatSharp.DiscordClient)">
<summary>
Creates a new EventWaiter object.
</summary>
<param name="client">Your DiscordClient</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Poller.DoPollAsync(DisCatSharp.Interactivity.EventHandling.PollRequest)">
<summary>
Dos the poll async.
</summary>
<param name="request">The request.</param>
<returns>A Task.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Poller.HandleReactionAdd(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.MessageReactionAddEventArgs)">
<summary>
Handles the reaction add.
</summary>
<param name="client">The client.</param>
<param name="eventArgs">The event's arguments.</param>
<returns>A Task.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Poller.HandleReactionRemove(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.MessageReactionRemoveEventArgs)">
<summary>
Handles the reaction remove.
</summary>
<param name="client">The client.</param>
<param name="eventArgs">The event's arguments.</param>
<returns>A Task.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Poller.HandleReactionClear(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.MessageReactionsClearEventArgs)">
<summary>
Handles the reaction clear.
</summary>
<param name="client">The client.</param>
<param name="eventArgs">The event's arguments.</param>
<returns>A Task.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.Poller.Dispose">
<summary>
Disposes this EventWaiter
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.ReactionCollector">
<summary>
EventWaiter is a class that serves as a layer between the InteractivityExtension
and the DiscordClient to listen to an event and check for matches to a predicate.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ReactionCollector.#ctor(DisCatSharp.DiscordClient)">
<summary>
Creates a new EventWaiter object.
</summary>
<param name="client">Your DiscordClient</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ReactionCollector.Dispose">
<summary>
Disposes this EventWaiter
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ReactionCollector.CollectAsync(DisCatSharp.Interactivity.EventHandling.ReactionCollectRequest)">
<summary>
Collects the async.
</summary>
<param name="request">The request.</param>
<returns>A Task.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ReactionCollector.HandleReactionAdd(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.MessageReactionAddEventArgs)">
<summary>
Handles the reaction add.
</summary>
<param name="client">The client.</param>
<param name="eventArgs">The event's arguments.</param>
<returns>A Task.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ReactionCollector.HandleReactionRemove(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.MessageReactionRemoveEventArgs)">
<summary>
Handles the reaction remove.
</summary>
<param name="client">The client.</param>
<param name="eventArgs">The event's arguments.</param>
<returns>A Task.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ReactionCollector.HandleReactionClear(DisCatSharp.DiscordClient,DisCatSharp.EventArgs.MessageReactionsClearEventArgs)">
<summary>
Handles the reaction clear.
</summary>
<param name="client">The client.</param>
<param name="eventArgs">The event's arguments.</param>
<returns>A Task.</returns>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.ReactionCollectRequest">
<summary>
The reaction collect request.
</summary>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ReactionCollectRequest.#ctor(DisCatSharp.Entities.DiscordMessage,System.TimeSpan)">
<summary>
Initializes a new instance of the <see cref="T:DisCatSharp.Interactivity.EventHandling.ReactionCollectRequest" /> class.
</summary>
<param name="msg">The msg.</param>
<param name="timeout">The timeout.</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.ReactionCollectRequest.Dispose">
<summary>
Disposes the.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.Reaction">
<summary>
The reaction.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.Reaction.Emoji">
<summary>
Gets the emoji.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.Reaction.Users">
<summary>
Gets the users.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.Reaction.Total">
<summary>
Gets the total.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.CollectRequest`1">
<summary>
CollectRequest is a class that serves as a representation of
EventArgs that are being collected within a specific time frame.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.CollectRequest`1.#ctor(System.Func{`0,System.Boolean},System.TimeSpan)">
<summary>
Creates a new CollectRequest object.
</summary>
<param name="predicate">Predicate to match</param>
<param name="timeout">Timeout time</param>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.CollectRequest`1.Dispose">
<summary>
Disposes this CollectRequest.
</summary>
</member>
<member name="T:DisCatSharp.Interactivity.EventHandling.IPaginationRequest">
<summary>
The pagination request.
</summary>
</member>
<member name="P:DisCatSharp.Interactivity.EventHandling.IPaginationRequest.PageCount">
<summary>
Returns the number of pages.
</summary>
<returns></returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.IPaginationRequest.GetPageAsync">
<summary>
Returns the current page.
</summary>
<returns></returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.IPaginationRequest.SkipLeftAsync">
<summary>
Tells the request to set its index to the first page.
</summary>
<returns></returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.IPaginationRequest.SkipRightAsync">
<summary>
Tells the request to set its index to the last page.
</summary>
<returns></returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.IPaginationRequest.NextPageAsync">
<summary>
Tells the request to increase its index by one.
</summary>
<returns></returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.IPaginationRequest.PreviousPageAsync">
<summary>
Tells the request to decrease its index by one.
</summary>
<returns></returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.IPaginationRequest.GetButtonsAsync">
<summary>
Requests the message buttons from the pagination request.
</summary>
<returns>The buttons.</returns>
</member>
<member name="M:DisCatSharp.Interactivity.EventHandling.IPaginationRequest.GetEmojisAsync">