-
Notifications
You must be signed in to change notification settings - Fork 1
/
Discord.Net.Rest.xml
7382 lines (7375 loc) · 390 KB
/
Discord.Net.Rest.xml
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>Discord.Net.Rest</name>
</assembly>
<members>
<member name="T:Discord.API.InviteVanity">
<summary>
Represents a vanity invite.
</summary>
</member>
<member name="P:Discord.API.InviteVanity.Code">
<summary>
The unique code for the invite link.
</summary>
</member>
<member name="P:Discord.API.InviteVanity.Uses">
<summary>
The total amount of vanity invite uses.
</summary>
</member>
<member name="P:Discord.API.MessageApplication.Id">
<summary>
Gets the snowflake ID of the application.
</summary>
</member>
<member name="P:Discord.API.MessageApplication.CoverImage">
<summary>
Gets the ID of the embed's image asset.
</summary>
</member>
<member name="P:Discord.API.MessageApplication.Description">
<summary>
Gets the application's description.
</summary>
</member>
<member name="P:Discord.API.MessageApplication.Icon">
<summary>
Gets the ID of the application's icon.
</summary>
</member>
<member name="P:Discord.API.MessageApplication.Name">
<summary>
Gets the name of the application.
</summary>
</member>
<member name="M:Discord.API.DiscordRestApiClient.#ctor(Discord.Net.Rest.RestClientProvider,System.String,Discord.RetryMode,Newtonsoft.Json.JsonSerializer,System.Boolean,System.Func{Discord.IRateLimitInfo,System.Threading.Tasks.Task})">
<exception cref="T:System.ArgumentException">Unknown OAuth token type.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.SetBaseUrl(System.String)">
<exception cref="T:System.ArgumentException">Unknown OAuth token type.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.GetPrefixedToken(Discord.TokenType,System.String)">
<exception cref="T:System.ArgumentException">Unknown OAuth token type.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.ModifyGuildChannelAsync(System.UInt64,Discord.API.Rest.ModifyGuildChannelParams,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException">
<paramref name="channelId"/> must not be equal to zero.
-and-
<paramref name="args.Position.Position"/> must be greater than zero.
</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="args"/> must not be <see langword="null"/>.
-and-
<paramref name="args.Name.Name"/> must not be <see langword="null"/> or empty.
</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.CreateMessageAsync(System.UInt64,Discord.API.Rest.CreateMessageParams,Discord.RequestOptions)">
<exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.CreateWebhookMessageAsync(System.UInt64,Discord.API.Rest.CreateWebhookMessageParams,Discord.RequestOptions,System.Nullable{System.UInt64})">
<exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
<exception cref="T:System.InvalidOperationException">This operation may only be called with a <see cref="F:Discord.TokenType.Webhook"/> token.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.ModifyWebhookMessageAsync(System.UInt64,System.UInt64,Discord.API.Rest.ModifyWebhookMessageParams,Discord.RequestOptions,System.Nullable{System.UInt64})">
<exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
<exception cref="T:System.InvalidOperationException">This operation may only be called with a <see cref="F:Discord.TokenType.Webhook"/> token.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.DeleteWebhookMessageAsync(System.UInt64,System.UInt64,Discord.RequestOptions,System.Nullable{System.UInt64})">
<exception cref="T:System.InvalidOperationException">This operation may only be called with a <see cref="F:Discord.TokenType.Webhook"/> token.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.UploadFileAsync(System.UInt64,Discord.API.Rest.UploadFileParams,Discord.RequestOptions)">
<exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.UploadWebhookFileAsync(System.UInt64,Discord.API.Rest.UploadWebhookFileParams,Discord.RequestOptions,System.Nullable{System.UInt64})">
<exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
<exception cref="T:System.InvalidOperationException">This operation may only be called with a <see cref="F:Discord.TokenType.Webhook"/> token.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.ModifyMessageAsync(System.UInt64,System.UInt64,Discord.API.Rest.ModifyMessageParams,Discord.RequestOptions)">
<exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.CreateGuildBanAsync(System.UInt64,System.UInt64,Discord.API.Rest.CreateGuildBanParams,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException">
<paramref name="guildId"/> and <paramref name="userId"/> must not be equal to zero.
-and-
<paramref name="args.DeleteMessageDays.DeleteMessageDays"/> must be between 0 to 7.
</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="args"/> must not be <see langword="null"/>.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.RemoveGuildBanAsync(System.UInt64,System.UInt64,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException"><paramref name="guildId"/> and <paramref name="userId"/> must not be equal to zero.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.GetGuildWidgetAsync(System.UInt64,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException"><paramref name="guildId"/> must not be equal to zero.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.ModifyGuildWidgetAsync(System.UInt64,Discord.API.Rest.ModifyGuildWidgetParams,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException"><paramref name="guildId"/> must not be equal to zero.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="args"/> must not be <see langword="null"/>.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.GetIntegrationsAsync(System.UInt64,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException"><paramref name="guildId"/> must not be equal to zero.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.GetInviteAsync(System.String,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException"><paramref name="inviteId"/> cannot be blank.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="inviteId"/> must not be <see langword="null"/>.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.GetVanityInviteAsync(System.UInt64,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException"><paramref name="guildId"/> may not be equal to zero.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.GetGuildInvitesAsync(System.UInt64,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException"><paramref name="guildId"/> may not be equal to zero.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.GetChannelInvitesAsync(System.UInt64,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException"><paramref name="channelId"/> may not be equal to zero.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.CreateChannelInviteAsync(System.UInt64,Discord.API.Rest.CreateChannelInviteParams,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException">
<paramref name="channelId"/> may not be equal to zero.
-and-
<paramref name="args.MaxAge.MaxAge"/> and <paramref name="args.MaxUses.MaxUses"/> must be greater than zero.
-and-
<paramref name="args.MaxAge.MaxAge"/> must be lesser than 86400.
</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="args"/> must not be <see langword="null"/>.</exception>
</member>
<member name="M:Discord.API.DiscordRestApiClient.CheckState">
<exception cref="T:System.InvalidOperationException">Client is not logged in.</exception>
</member>
<member name="M:Discord.Net.Rest.DefaultRestClient.SendAsync(System.String,System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object},System.Threading.CancellationToken,System.Boolean,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.IEnumerable{System.String}}})">
<exception cref="T:System.InvalidOperationException">Unsupported param type.</exception>
</member>
<member name="M:Discord.Net.Rest.DefaultRestClientProvider.Create(System.Boolean)">
<exception cref="T:System.PlatformNotSupportedException">The default RestClientProvider is not supported on this platform.</exception>
</member>
<member name="M:Discord.Net.Converters.ImageConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<exception cref="T:System.InvalidOperationException">Cannot read from image.</exception>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.ConstantTimeEquals(System.Byte[],System.Byte[])">
<summary>
Comparison of two arrays.
The runtime of this method does not depend on the contents of the arrays. Using constant time
prevents timing attacks that allow an attacker to learn if the arrays have a common prefix.
It is important to use such a constant time comparison when verifying MACs.
</summary>
<param name="x">Byte array</param>
<param name="y">Byte array</param>
<returns>True if arrays are equal</returns>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.ConstantTimeEquals(System.ArraySegment{System.Byte},System.ArraySegment{System.Byte})">
<summary>
Comparison of two array segments.
The runtime of this method does not depend on the contents of the arrays. Using constant time
prevents timing attacks that allow an attacker to learn if the arrays have a common prefix.
It is important to use such a constant time comparison when verifying MACs.
</summary>
<param name="x">Byte array segment</param>
<param name="y">Byte array segment</param>
<returns>True if contents of x and y are equal</returns>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.ConstantTimeEquals(System.Byte[],System.Int32,System.Byte[],System.Int32,System.Int32)">
<summary>
Comparison of two byte sequences.
The runtime of this method does not depend on the contents of the arrays. Using constant time
prevents timing attacks that allow an attacker to learn if the arrays have a common prefix.
It is important to use such a constant time comparison when verifying MACs.
</summary>
<param name="x">Byte array</param>
<param name="xOffset">Offset of byte sequence in the x array</param>
<param name="y">Byte array</param>
<param name="yOffset">Offset of byte sequence in the y array</param>
<param name="length">Lengh of byte sequence</param>
<returns>True if sequences are equal</returns>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.Wipe(System.Byte[])">
<summary>
Overwrites the contents of the array, wiping the previous content.
</summary>
<param name="data">Byte array</param>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.Wipe(System.Byte[],System.Int32,System.Int32)">
<summary>
Overwrites the contents of the array, wiping the previous content.
</summary>
<param name="data">Byte array</param>
<param name="offset">Index of byte sequence</param>
<param name="length">Length of byte sequence</param>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.Wipe(System.ArraySegment{System.Byte})">
<summary>
Overwrites the contents of the array segment, wiping the previous content.
</summary>
<param name="data">Byte array segment</param>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.ToHexStringUpper(System.Byte[])">
<summary>
Constant-time conversion of the bytes array to an upper-case hex string.
Please see http://stackoverflow.com/a/14333437/445517 for the detailed explanation
</summary>
<param name="data">Byte array</param>
<returns>Hex representation of byte array</returns>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.ToHexStringLower(System.Byte[])">
<summary>
Constant-time conversion of the bytes array to an lower-case hex string.
Please see http://stackoverflow.com/a/14333437/445517 for the detailed explanation.
</summary>
<param name="data">Byte array</param>
<returns>Hex representation of byte array</returns>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.FromHexString(System.String)">
<summary>
Converts the hex string to bytes. Case insensitive.
</summary>
<param name="hexString">Hex encoded byte sequence</param>
<returns>Byte array</returns>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.ToBase64String(System.Byte[])">
<summary>
Encodes the bytes with the Base64 encoding.
More compact than hex, but it is case-sensitive and uses the special characters `+`, `/` and `=`.
</summary>
<param name="data">Byte array</param>
<returns>Base 64 encoded data</returns>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.FromBase64String(System.String)">
<summary>
Decodes a Base64 encoded string back to bytes.
</summary>
<param name="base64String">Base 64 encoded data</param>
<returns>Byte array</returns>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.Base58Encode(System.Byte[])">
<summary>
Encode a byte sequence as a base58-encoded string
</summary>
<param name="input">Byte sequence</param>
<returns>Encoding result</returns>
</member>
<member name="M:Discord.Net.ED25519.CryptoBytes.Base58Decode(System.String)">
<summary>
// Decode a base58-encoded string into byte array
</summary>
<param name="input">Base58 data string</param>
<returns>Byte array</returns>
</member>
<member name="F:Discord.Net.ED25519.Ed25519.PublicKeySize">
<summary>
Public Keys are 32 byte values. All possible values of this size a valid.
</summary>
</member>
<member name="F:Discord.Net.ED25519.Ed25519.SignatureSize">
<summary>
Signatures are 64 byte values
</summary>
</member>
<member name="F:Discord.Net.ED25519.Ed25519.PrivateKeySeedSize">
<summary>
Private key seeds are 32 byte arbitrary values. This is the form that should be generated and stored.
</summary>
</member>
<member name="F:Discord.Net.ED25519.Ed25519.ExpandedPrivateKeySize">
<summary>
A 64 byte expanded form of private key. This form is used internally to improve performance
</summary>
</member>
<member name="M:Discord.Net.ED25519.Ed25519.Verify(System.ArraySegment{System.Byte},System.ArraySegment{System.Byte},System.ArraySegment{System.Byte})">
<summary>
Verify Ed25519 signature
</summary>
<param name="signature">Signature bytes</param>
<param name="message">Message</param>
<param name="publicKey">Public key</param>
<returns>True if signature is valid, false if it's not</returns>
</member>
<member name="M:Discord.Net.ED25519.Ed25519.Verify(System.Byte[],System.Byte[],System.Byte[])">
<summary>
Verify Ed25519 signature
</summary>
<param name="signature">Signature bytes</param>
<param name="message">Message</param>
<param name="publicKey">Public key</param>
<returns>True if signature is valid, false if it's not</returns>
</member>
<member name="M:Discord.Net.ED25519.Sha512.#ctor">
<summary>
Allocation and initialization of the new SHA-512 object.
</summary>
</member>
<member name="M:Discord.Net.ED25519.Sha512.Init">
<summary>
Performs an initialization of internal SHA-512 state.
</summary>
</member>
<member name="M:Discord.Net.ED25519.Sha512.Update(System.ArraySegment{System.Byte})">
<summary>
Updates internal state with data from the provided array segment.
</summary>
<param name="data">Array segment</param>
</member>
<member name="M:Discord.Net.ED25519.Sha512.Update(System.Byte[],System.Int32,System.Int32)">
<summary>
Updates internal state with data from the provided array.
</summary>
<param name="data">Array of bytes</param>
<param name="index">Offset of byte sequence</param>
<param name="length">Sequence length</param>
</member>
<member name="M:Discord.Net.ED25519.Sha512.Finalize(System.ArraySegment{System.Byte})">
<summary>
Finalizes SHA-512 hashing
</summary>
<param name="output">Output buffer</param>
</member>
<member name="M:Discord.Net.ED25519.Sha512.Finalize">
<summary>
Finalizes SHA-512 hashing.
</summary>
<returns>Hash bytes</returns>
</member>
<member name="M:Discord.Net.ED25519.Sha512.Hash(System.Byte[])">
<summary>
Calculates SHA-512 hash value for the given bytes array.
</summary>
<param name="data">Data bytes array</param>
<returns>Hash bytes</returns>
</member>
<member name="M:Discord.Net.ED25519.Sha512.Hash(System.Byte[],System.Int32,System.Int32)">
<summary>
Calculates SHA-512 hash value for the given bytes array.
</summary>
<param name="data">Data bytes array</param>
<param name="index">Offset of byte sequence</param>
<param name="length">Sequence length</param>
<returns>Hash bytes</returns>
</member>
<member name="T:Discord.Net.RateLimitInfo">
<summary>
Represents a REST-Based ratelimit info.
</summary>
</member>
<member name="P:Discord.Net.RateLimitInfo.IsGlobal">
<inheritdoc/>
</member>
<member name="P:Discord.Net.RateLimitInfo.Limit">
<inheritdoc/>
</member>
<member name="P:Discord.Net.RateLimitInfo.Remaining">
<inheritdoc/>
</member>
<member name="P:Discord.Net.RateLimitInfo.RetryAfter">
<inheritdoc/>
</member>
<member name="P:Discord.Net.RateLimitInfo.Reset">
<inheritdoc/>
</member>
<member name="P:Discord.Net.RateLimitInfo.ResetAfter">
<inheritdoc/>
</member>
<member name="P:Discord.Net.RateLimitInfo.Bucket">
<inheritdoc/>
</member>
<member name="P:Discord.Net.RateLimitInfo.Lag">
<inheritdoc/>
</member>
<member name="P:Discord.Net.RateLimitInfo.Endpoint">
<inheritdoc/>
</member>
<member name="P:Discord.Rest.BaseDiscordClient.LoginState">
<summary>
Gets the login state of the client.
</summary>
</member>
<member name="P:Discord.Rest.BaseDiscordClient.CurrentUser">
<summary>
Gets the logged-in user.
</summary>
</member>
<member name="P:Discord.Rest.BaseDiscordClient.TokenType">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.#ctor(Discord.Rest.DiscordRestConfig,Discord.API.DiscordRestApiClient)">
<summary> Creates a new REST-only Discord client. </summary>
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Dispose">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.GetRecommendedShardCountAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.GetBotGatewayAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="P:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#ConnectionState">
<inheritdoc />
</member>
<member name="P:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CurrentUser">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetDMChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGroupChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetInviteAsync(System.String,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">
<inheritdoc />
<exception cref="T:System.NotSupportedException">Creating a guild is not supported with the base client.</exception>
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetUserAsync(System.String,System.String,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGlobalApplicationCommandAsync(System.UInt64,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGlobalApplicationCommandsAsync(System.Boolean,System.String,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StartAsync">
<inheritdoc />
</member>
<member name="M:Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StopAsync">
<inheritdoc />
</member>
<member name="M:Discord.Rest.ClientHelper.GetPrivateChannelsAsync(Discord.Rest.BaseDiscordClient,Discord.RequestOptions)">
<exception cref="T:System.InvalidOperationException">Unexpected channel type.</exception>
</member>
<member name="T:Discord.Rest.DiscordRestClient">
<summary>
Provides a client to send REST-based requests to Discord.
</summary>
</member>
<member name="P:Discord.Rest.DiscordRestClient.CurrentUser">
<summary>
Gets the logged-in user.
</summary>
</member>
<member name="M:Discord.Rest.DiscordRestClient.#ctor">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.#ctor(Discord.Rest.DiscordRestConfig)">
<summary>
Initializes a new <see cref="T:Discord.Rest.DiscordRestClient"/> with the provided configuration.
</summary>
<param name="config">The configuration to be used with the client.</param>
</member>
<member name="M:Discord.Rest.DiscordRestClient.OnLoginAsync(Discord.TokenType,System.String)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.OnLogoutAsync">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.ParseHttpInteractionAsync(System.String,System.String,System.String,System.String,System.Func{Discord.Rest.InteractionProperties,System.Boolean})">
<summary>
Creates a <see cref="T:Discord.Rest.RestInteraction"/> from a http message.
</summary>
<param name="publicKey">The public key of your application</param>
<param name="signature">The signature sent with the interaction.</param>
<param name="timestamp">The timestamp sent with the interaction.</param>
<param name="body">The body of the http message.</param>
<returns>
A <see cref="T:Discord.Rest.RestInteraction"/> that represents the incoming http interaction.
</returns>
<exception cref="T:Discord.Rest.BadSignatureException">Thrown when the signature doesn't match the public key.</exception>
</member>
<member name="M:Discord.Rest.DiscordRestClient.ParseHttpInteractionAsync(System.String,System.String,System.String,System.Byte[],System.Func{Discord.Rest.InteractionProperties,System.Boolean})">
<summary>
Creates a <see cref="T:Discord.Rest.RestInteraction"/> from a http message.
</summary>
<param name="publicKey">The public key of your application</param>
<param name="signature">The signature sent with the interaction.</param>
<param name="timestamp">The timestamp sent with the interaction.</param>
<param name="body">The body of the http message.</param>
<returns>
A <see cref="T:Discord.Rest.RestInteraction"/> that represents the incoming http interaction.
</returns>
<exception cref="T:Discord.Rest.BadSignatureException">Thrown when the signature doesn't match the public key.</exception>
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetDMChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGroupChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGlobalApplicationCommandsAsync(System.Boolean,System.String,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGlobalApplicationCommandAsync(System.UInt64,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="T:Discord.Rest.DiscordRestConfig">
<summary>
Represents a configuration class for <see cref="T:Discord.Rest.DiscordRestClient"/>.
</summary>
</member>
<member name="P:Discord.Rest.DiscordRestConfig.RestClientProvider">
<summary> Gets or sets the provider used to generate new REST connections. </summary>
</member>
<member name="T:Discord.Rest.BanAuditLogData">
<summary>
Contains a piece of audit log data related to a ban.
</summary>
</member>
<member name="P:Discord.Rest.BanAuditLogData.Target">
<summary>
Gets the user that was banned.
</summary>
<remarks>
Will be <see langword="null"/> if the user is a 'Deleted User#....' because Discord does send user data for deleted users.
</remarks>
<returns>
A user object representing the banned user.
</returns>
</member>
<member name="T:Discord.Rest.BotAddAuditLogData">
<summary>
Contains a piece of audit log data related to a adding a bot to a guild.
</summary>
</member>
<member name="P:Discord.Rest.BotAddAuditLogData.Target">
<summary>
Gets the bot that was added.
</summary>
<remarks>
Will be <see langword="null"/> if the bot is a 'Deleted User#....' because Discord does send user data for deleted users.
</remarks>
<returns>
A user object representing the bot.
</returns>
</member>
<member name="T:Discord.Rest.ChannelCreateAuditLogData">
<summary>
Contains a piece of audit log data related to a channel creation.
</summary>
</member>
<member name="P:Discord.Rest.ChannelCreateAuditLogData.ChannelId">
<summary>
Gets the snowflake ID of the created channel.
</summary>
<returns>
A <see cref="T:System.UInt64"/> representing the snowflake identifier for the created channel.
</returns>
</member>
<member name="P:Discord.Rest.ChannelCreateAuditLogData.ChannelName">
<summary>
Gets the name of the created channel.
</summary>
<returns>
A string containing the name of the created channel.
</returns>
</member>
<member name="P:Discord.Rest.ChannelCreateAuditLogData.ChannelType">
<summary>
Gets the type of the created channel.
</summary>
<returns>
The type of channel that was created.
</returns>
</member>
<member name="P:Discord.Rest.ChannelCreateAuditLogData.SlowModeInterval">
<summary>
Gets the current slow-mode delay of the created channel.
</summary>
<returns>
An <see cref="T:System.Int32"/> representing the time in seconds required before the user can send another
message; <c>0</c> if disabled.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.ChannelCreateAuditLogData.IsNsfw">
<summary>
Gets the value that indicates whether the created channel is NSFW.
</summary>
<returns>
<c>true</c> if the created channel has the NSFW flag enabled; otherwise <c>false</c>.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.ChannelCreateAuditLogData.Bitrate">
<summary>
Gets the bit-rate that the clients in the created voice channel are requested to use.
</summary>
<returns>
An <see cref="T:System.Int32"/> representing the bit-rate (bps) that the created voice channel defines and requests the
client(s) to use.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.ChannelCreateAuditLogData.Overwrites">
<summary>
Gets a collection of permission overwrites that was assigned to the created channel.
</summary>
<returns>
A collection of permission <see cref="T:Discord.Overwrite"/>, containing the permission overwrites that were
assigned to the created channel.
</returns>
</member>
<member name="T:Discord.Rest.ChannelDeleteAuditLogData">
<summary>
Contains a piece of audit log data related to a channel deletion.
</summary>
</member>
<member name="P:Discord.Rest.ChannelDeleteAuditLogData.ChannelId">
<summary>
Gets the snowflake ID of the deleted channel.
</summary>
<returns>
A <see cref="T:System.UInt64"/> representing the snowflake identifier for the deleted channel.
</returns>
</member>
<member name="P:Discord.Rest.ChannelDeleteAuditLogData.ChannelName">
<summary>
Gets the name of the deleted channel.
</summary>
<returns>
A string containing the name of the deleted channel.
</returns>
</member>
<member name="P:Discord.Rest.ChannelDeleteAuditLogData.ChannelType">
<summary>
Gets the type of the deleted channel.
</summary>
<returns>
The type of channel that was deleted.
</returns>
</member>
<member name="P:Discord.Rest.ChannelDeleteAuditLogData.SlowModeInterval">
<summary>
Gets the slow-mode delay of the deleted channel.
</summary>
<returns>
An <see cref="T:System.Int32"/> representing the time in seconds required before the user can send another
message; <c>0</c> if disabled.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.ChannelDeleteAuditLogData.IsNsfw">
<summary>
Gets the value that indicates whether the deleted channel was NSFW.
</summary>
<returns>
<c>true</c> if this channel had the NSFW flag enabled; otherwise <c>false</c>.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.ChannelDeleteAuditLogData.Bitrate">
<summary>
Gets the bit-rate of this channel if applicable.
</summary>
<returns>
An <see cref="T:System.Int32"/> representing the bit-rate set of the voice channel.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.ChannelDeleteAuditLogData.Overwrites">
<summary>
Gets a collection of permission overwrites that was assigned to the deleted channel.
</summary>
<returns>
A collection of permission <see cref="T:Discord.Overwrite"/>.
</returns>
</member>
<member name="T:Discord.Rest.ChannelInfo">
<summary>
Represents information for a channel.
</summary>
</member>
<member name="P:Discord.Rest.ChannelInfo.Name">
<summary>
Gets the name of this channel.
</summary>
<returns>
A string containing the name of this channel.
</returns>
</member>
<member name="P:Discord.Rest.ChannelInfo.Topic">
<summary>
Gets the topic of this channel.
</summary>
<returns>
A string containing the topic of this channel, if any.
</returns>
</member>
<member name="P:Discord.Rest.ChannelInfo.SlowModeInterval">
<summary>
Gets the current slow-mode delay of this channel.
</summary>
<returns>
An <see cref="T:System.Int32"/> representing the time in seconds required before the user can send another
message; <c>0</c> if disabled.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.ChannelInfo.IsNsfw">
<summary>
Gets the value that indicates whether this channel is NSFW.
</summary>
<returns>
<c>true</c> if this channel has the NSFW flag enabled; otherwise <c>false</c>.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.ChannelInfo.Bitrate">
<summary>
Gets the bit-rate of this channel if applicable.
</summary>
<returns>
An <see cref="T:System.Int32"/> representing the bit-rate set for the voice channel;
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.ChannelInfo.ChannelType">
<summary>
Gets the type of this channel.
</summary>
<returns>
The channel type of this channel; <c>null</c> if not applicable.
</returns>
</member>
<member name="T:Discord.Rest.ChannelUpdateAuditLogData">
<summary>
Contains a piece of audit log data related to a channel update.
</summary>
</member>
<member name="P:Discord.Rest.ChannelUpdateAuditLogData.ChannelId">
<summary>
Gets the snowflake ID of the updated channel.
</summary>
<returns>
A <see cref="T:System.UInt64"/> representing the snowflake identifier for the updated channel.
</returns>
</member>
<member name="P:Discord.Rest.ChannelUpdateAuditLogData.Before">
<summary>
Gets the channel information before the changes.
</summary>
<returns>
An information object containing the original channel information before the changes were made.
</returns>
</member>
<member name="P:Discord.Rest.ChannelUpdateAuditLogData.After">
<summary>
Gets the channel information after the changes.
</summary>
<returns>
An information object containing the channel information after the changes were made.
</returns>
</member>
<member name="T:Discord.Rest.EmoteCreateAuditLogData">
<summary>
Contains a piece of audit log data related to an emoji creation.
</summary>
</member>
<member name="P:Discord.Rest.EmoteCreateAuditLogData.EmoteId">
<summary>
Gets the snowflake ID of the created emoji.
</summary>
<returns>
A <see cref="T:System.UInt64"/> representing the snowflake identifier for the created emoji.
</returns>
</member>
<member name="P:Discord.Rest.EmoteCreateAuditLogData.Name">
<summary>
Gets the name of the created emoji.
</summary>
<returns>
A string containing the name of the created emoji.
</returns>
</member>
<member name="T:Discord.Rest.EmoteDeleteAuditLogData">
<summary>
Contains a piece of audit log data related to an emoji deletion.
</summary>
</member>
<member name="P:Discord.Rest.EmoteDeleteAuditLogData.EmoteId">
<summary>
Gets the snowflake ID of the deleted emoji.
</summary>
<returns>
A <see cref="T:System.UInt64"/> representing the snowflake identifier for the deleted emoji.
</returns>
</member>
<member name="P:Discord.Rest.EmoteDeleteAuditLogData.Name">
<summary>
Gets the name of the deleted emoji.
</summary>
<returns>
A string containing the name of the deleted emoji.
</returns>
</member>
<member name="T:Discord.Rest.EmoteUpdateAuditLogData">
<summary>
Contains a piece of audit log data related to an emoji update.
</summary>
</member>
<member name="P:Discord.Rest.EmoteUpdateAuditLogData.EmoteId">
<summary>
Gets the snowflake ID of the updated emoji.
</summary>
<returns>
A <see cref="T:System.UInt64"/> representing the snowflake identifier of the updated emoji.
</returns>
</member>
<member name="P:Discord.Rest.EmoteUpdateAuditLogData.NewName">
<summary>
Gets the new name of the updated emoji.
</summary>
<returns>
A string containing the new name of the updated emoji.
</returns>
</member>
<member name="P:Discord.Rest.EmoteUpdateAuditLogData.OldName">
<summary>
Gets the old name of the updated emoji.
</summary>
<returns>
A string containing the old name of the updated emoji.
</returns>
</member>
<member name="T:Discord.Rest.GuildInfo">
<summary>
Represents information for a guild.
</summary>
</member>
<member name="P:Discord.Rest.GuildInfo.AfkTimeout">
<summary>
Gets the amount of time (in seconds) a user must be inactive in a voice channel for until they are
automatically moved to the AFK voice channel.
</summary>
<returns>
An <see cref="T:System.Int32"/> representing the amount of time in seconds for a user to be marked as inactive
and moved into the AFK voice channel.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.GuildInfo.DefaultMessageNotifications">
<summary>
Gets the default message notifications for users who haven't explicitly set their notification settings.
</summary>
<returns>
The default message notifications setting of this guild.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.GuildInfo.AfkChannelId">
<summary>
Gets the ID of the AFK voice channel for this guild.
</summary>
<returns>
A <see cref="T:System.UInt64"/> representing the snowflake identifier of the AFK voice channel; <c>null</c> if
none is set.
</returns>
</member>
<member name="P:Discord.Rest.GuildInfo.Name">
<summary>
Gets the name of this guild.
</summary>
<returns>
A string containing the name of this guild.
</returns>
</member>
<member name="P:Discord.Rest.GuildInfo.RegionId">
<summary>
Gets the ID of the region hosting this guild's voice channels.
</summary>
</member>
<member name="P:Discord.Rest.GuildInfo.IconHash">
<summary>
Gets the ID of this guild's icon.
</summary>
<returns>
A string containing the identifier for the splash image; <c>null</c> if none is set.
</returns>
</member>
<member name="P:Discord.Rest.GuildInfo.VerificationLevel">
<summary>
Gets the level of requirements a user must fulfill before being allowed to post messages in this guild.
</summary>
<returns>
The level of requirements.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.GuildInfo.Owner">
<summary>
Gets the owner of this guild.
</summary>
<returns>
A user object representing the owner of this guild.
</returns>
</member>
<member name="P:Discord.Rest.GuildInfo.MfaLevel">
<summary>
Gets the level of Multi-Factor Authentication requirements a user must fulfill before being allowed to
perform administrative actions in this guild.
</summary>
<returns>
The level of MFA requirement.
<c>null</c> if this is not mentioned in this entry.
</returns>
</member>
<member name="P:Discord.Rest.GuildInfo.ExplicitContentFilter">
<summary>
Gets the level of content filtering applied to user's content in a Guild.
</summary>
<returns>
The level of explicit content filtering.
</returns>
</member>
<member name="P:Discord.Rest.GuildInfo.SystemChannelId">
<summary>
Gets the ID of the channel where system messages are sent.
</summary>
<returns>
A <see cref="T:System.UInt64"/> representing the snowflake identifier of the channel where system
messages are sent; <c>null</c> if none is set.
</returns>
</member>
<member name="P:Discord.Rest.GuildInfo.EmbedChannelId">