-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathDiscord.Net.WebSocket.xml
More file actions
6996 lines (6996 loc) · 383 KB
/
Discord.Net.WebSocket.xml
File metadata and controls
6996 lines (6996 loc) · 383 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>Discord.Net.WebSocket</name>
</assembly>
<members>
<member name="F:Discord.API.Gateway.GatewayOpCode.Dispatch">
<summary> C←S - Used to send most events. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.Heartbeat">
<summary> C↔S - Used to keep the connection alive and measure latency. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.Identify">
<summary> C→S - Used to associate a connection with a token and specify configuration. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.PresenceUpdate">
<summary> C→S - Used to update client's status and current game id. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.VoiceStateUpdate">
<summary> C→S - Used to join a particular voice channel. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.VoiceServerPing">
<summary> C→S - Used to ensure the guild's voice server is alive. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.Resume">
<summary> C→S - Used to resume a connection after a redirect occurs. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.Reconnect">
<summary> C←S - Used to notify a client that they must reconnect to another gateway. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.RequestGuildMembers">
<summary> C→S - Used to request members that were withheld by large_threshold </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.InvalidSession">
<summary> C←S - Used to notify the client that their session has expired and cannot be resumed. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.Hello">
<summary> C←S - Used to provide information to the client immediately on connection. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.HeartbeatAck">
<summary> C←S - Used to reply to a client's heartbeat. </summary>
</member>
<member name="F:Discord.API.Gateway.GatewayOpCode.GuildSync">
<summary> C→S - Used to request presence updates from particular guilds. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.Identify">
<summary> C→S - Used to associate a connection with a token. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.SelectProtocol">
<summary> C→S - Used to specify configuration. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.Ready">
<summary> C←S - Used to notify that the voice connection was successful and informs the client of available protocols. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.Heartbeat">
<summary> C→S - Used to keep the connection alive and measure latency. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.SessionDescription">
<summary> C←S - Used to provide an encryption key to the client. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.Speaking">
<summary> C↔S - Used to inform that a certain user is speaking. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.HeartbeatAck">
<summary> C←S - Used to reply to a client's heartbeat. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.Resume">
<summary> C→S - Used to resume a connection. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.Hello">
<summary> C←S - Used to inform the client the heartbeat interval. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.Resumed">
<summary> C←S - Used to acknowledge a resumed connection. </summary>
</member>
<member name="F:Discord.API.Voice.VoiceOpCode.ClientDisconnect">
<summary> C←S - Used to notify that a client has disconnected. </summary>
</member>
<member name="P:Discord.API.DiscordSocketApiClient.GatewayUrl">
<summary>
Sets the gateway URL used for identifies.
</summary>
<remarks>
If a custom URL is set, setting this property does nothing.
</remarks>
</member>
<member name="P:Discord.API.DiscordSocketApiClient.ResumeGatewayUrl">
<summary>
Sets the gateway URL used for resumes.
</summary>
</member>
<member name="M:Discord.API.DiscordSocketApiClient.FormatGatewayUrl(System.String)">
<summary>
Appends necessary query parameters to the specified gateway URL.
</summary>
</member>
<member name="M:Discord.API.DiscordSocketApiClient.ConnectInternalAsync">
<exception cref="T:System.InvalidOperationException">The client must be logged in before connecting.</exception>
<exception cref="T:System.NotSupportedException">This client is not configured with WebSocket support.</exception>
</member>
<member name="M:Discord.API.DiscordSocketApiClient.DisconnectInternalAsync(System.Exception)">
<exception cref="T:System.NotSupportedException">This client is not configured with WebSocket support.</exception>
</member>
<member name="T:Discord.WebSocket.VoiceCloseCode">
<summary>
Represents generic op codes for voice disconnect.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.UnknownOpcode">
<summary>
You sent an invalid opcode.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.DecodeFailure">
<summary>
You sent an invalid payload in your identifying to the Gateway.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.NotAuthenticated">
<summary>
You sent a payload before identifying with the Gateway.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.AuthenticationFailed">
<summary>
The token you sent in your identify payload is incorrect.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.AlreadyAuthenticated">
<summary>
You sent more than one identify payload. Stahp.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.SessionNolongerValid">
<summary>
Your session is no longer valid.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.SessionTimeout">
<summary>
Your session has timed out.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.ServerNotFound">
<summary>
We can't find the server you're trying to connect to.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.UnknownProtocol">
<summary>
We didn't recognize the protocol you sent.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.Disconnected">
<summary>
Channel was deleted, you were kicked, voice server changed, or the main gateway session was dropped. Should not reconnect.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.VoiceServerCrashed">
<summary>
The server crashed. Our bad! Try resuming.
</summary>
</member>
<member name="F:Discord.WebSocket.VoiceCloseCode.UnknownEncryptionMode">
<summary>
We didn't recognize your encryption.
</summary>
</member>
<member name="T:Discord.WebSocket.BaseSocketClient">
<summary>
Represents the base of a WebSocket-based Discord client.
</summary>
</member>
<member name="P:Discord.WebSocket.BaseSocketClient.Latency">
<summary>
Gets the estimated round-trip latency, in milliseconds, to the gateway server.
</summary>
<returns>
An <see cref="T:System.Int32"/> that represents the round-trip latency to the WebSocket server. Please
note that this value does not represent a "true" latency for operations such as sending a message.
</returns>
</member>
<member name="P:Discord.WebSocket.BaseSocketClient.Status">
<summary>
Gets the status for the logged-in user.
</summary>
<returns>
A status object that represents the user's online presence status.
</returns>
</member>
<member name="P:Discord.WebSocket.BaseSocketClient.Activity">
<summary>
Gets the activity for the logged-in user.
</summary>
<returns>
An activity object that represents the user's current activity.
</returns>
</member>
<member name="P:Discord.WebSocket.BaseSocketClient.Rest">
<summary>
Provides access to a REST-only client with a shared state from this client.
</summary>
</member>
<member name="P:Discord.WebSocket.BaseSocketClient.DefaultStickerPacks">
<summary>
Gets a collection of default stickers.
</summary>
</member>
<member name="P:Discord.WebSocket.BaseSocketClient.CurrentUser">
<summary>
Gets the current logged-in user.
</summary>
</member>
<member name="P:Discord.WebSocket.BaseSocketClient.Guilds">
<summary>
Gets a collection of guilds that the user is currently in.
</summary>
<returns>
A read-only collection of guilds that the current user is in.
</returns>
</member>
<member name="P:Discord.WebSocket.BaseSocketClient.PrivateChannels">
<summary>
Gets a collection of private channels opened in this session.
</summary>
<remarks>
This method will retrieve all private channels (including direct-message, group channel and such) that
are currently opened in this session.
<note type="warning">
This method will not return previously opened private channels outside of the current session! If
you have just started the client, this may return an empty collection.
</note>
</remarks>
<returns>
A read-only collection of private channels that the user currently partakes in.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.GetApplicationInfoAsync(Discord.RequestOptions)">
<summary>
Gets a Discord application information for the logged-in user.
</summary>
<remarks>
This method reflects your application information you submitted when creating a Discord application via
the Developer Portal.
</remarks>
<param name="options">The options to be used when sending the request.</param>
<returns>
A task that represents the asynchronous get operation. The task result contains the application
information.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.GetUser(System.UInt64)">
<summary>
Gets a generic user.
</summary>
<param name="id">The user snowflake ID.</param>
<remarks>
This method gets the user present in the WebSocket cache with the given condition.
<note type="warning">
Sometimes a user may return <c>null</c> due to Discord not sending offline users in large guilds
(i.e. guild with 100+ members) actively. To download users on startup and to see more information
about this subject, see <see cref="P:Discord.WebSocket.DiscordSocketConfig.AlwaysDownloadUsers" />.
</note>
<note>
This method does not attempt to fetch users that the logged-in user does not have access to (i.e.
users who don't share mutual guild(s) with the current user). If you wish to get a user that you do
not have access to, consider using the REST implementation of
<see cref="M:Discord.Rest.DiscordRestClient.GetUserAsync(System.UInt64,Discord.RequestOptions)" />.
</note>
</remarks>
<returns>
A generic WebSocket-based user; <c>null</c> when the user cannot be found.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.GetUser(System.String,System.String)">
<summary>
Gets a user.
</summary>
<remarks>
This method gets the user present in the WebSocket cache with the given condition.
<note type="warning">
Sometimes a user may return <c>null</c> due to Discord not sending offline users in large guilds
(i.e. guild with 100+ members) actively. To download users on startup and to see more information
about this subject, see <see cref="P:Discord.WebSocket.DiscordSocketConfig.AlwaysDownloadUsers" />.
</note>
<note>
This method does not attempt to fetch users that the logged-in user does not have access to (i.e.
users who don't share mutual guild(s) with the current user). If you wish to get a user that you do
not have access to, consider using the REST implementation of
<see cref="M:Discord.Rest.DiscordRestClient.GetUserAsync(System.UInt64,Discord.RequestOptions)" />.
</note>
</remarks>
<param name="username">The name of the user.</param>
<param name="discriminator">The discriminator value of the user.</param>
<returns>
A generic WebSocket-based user; <c>null</c> when the user cannot be found.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.GetChannel(System.UInt64)">
<summary>
Gets a channel.
</summary>
<param name="id">The snowflake identifier of the channel (e.g. `381889909113225237`).</param>
<returns>
A generic WebSocket-based channel object (voice, text, category, etc.) associated with the identifier;
<c>null</c> when the channel cannot be found.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.GetGuild(System.UInt64)">
<summary>
Gets a guild.
</summary>
<param name="id">The guild snowflake identifier.</param>
<returns>
A WebSocket-based guild associated with the snowflake identifier; <c>null</c> when the guild cannot be
found.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.GetVoiceRegionsAsync(Discord.RequestOptions)">
<summary>
Gets all voice regions.
</summary>
<param name="options">The options to be used when sending the request.</param>
<returns>
A task that contains a read-only collection of REST-based voice regions.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
<summary>
Gets a voice region.
</summary>
<param name="id">The identifier of the voice region (e.g. <c>eu-central</c> ).</param>
<param name="options">The options to be used when sending the request.</param>
<returns>
A task that contains a REST-based voice region associated with the identifier; <c>null</c> if the
voice region is not found.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.StartAsync">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.StopAsync">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.SetStatusAsync(Discord.UserStatus)">
<summary>
Sets the current status of the user (e.g. Online, Do not Disturb).
</summary>
<param name="status">The new status to be set.</param>
<returns>
A task that represents the asynchronous set operation.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.SetGameAsync(System.String,System.String,Discord.ActivityType)">
<summary>
Sets the game of the user.
</summary>
<param name="name">The name of the game.</param>
<param name="streamUrl">If streaming, the URL of the stream. Must be a valid Twitch URL.</param>
<param name="type">The type of the game.</param>
<remarks>
<note type="warning">
Bot accounts cannot set <see cref="F:Discord.ActivityType.CustomStatus"/> as their activity
type and it will have no effect.
</note>
</remarks>
<returns>
A task that represents the asynchronous set operation.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.SetActivityAsync(Discord.IActivity)">
<summary>
Sets the <paramref name="activity"/> of the logged-in user.
</summary>
<remarks>
This method sets the <paramref name="activity"/> of the user.
<note type="note">
Discord will only accept setting of name and the type of activity.
</note>
<note type="warning">
Bot accounts cannot set <see cref="F:Discord.ActivityType.CustomStatus"/> as their activity
type and it will have no effect.
</note>
<note type="warning">
Rich Presence cannot be set via this method or client. Rich Presence is strictly limited to RPC
clients only.
</note>
</remarks>
<param name="activity">The activity to be set.</param>
<returns>
A task that represents the asynchronous set operation.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.DownloadUsersAsync(System.Collections.Generic.IEnumerable{Discord.IGuild})">
<summary>
Attempts to download users into the user cache for the selected guilds.
</summary>
<param name="guilds">The guilds to download the members from.</param>
<returns>
A task that represents the asynchronous download operation.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">
<summary>
Creates a guild for the logged-in user who is in less than 10 active guilds.
</summary>
<remarks>
This method creates a new guild on behalf of the logged-in user.
<note type="warning">
Due to Discord's limitation, this method will only work for users that are in less than 10 guilds.
</note>
</remarks>
<param name="name">The name of the new guild.</param>
<param name="region">The voice region to create the guild with.</param>
<param name="jpegIcon">The icon of the guild.</param>
<param name="options">The options to be used when sending the request.</param>
<returns>
A task that represents the asynchronous creation operation. The task result contains the created guild.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.GetConnectionsAsync(Discord.RequestOptions)">
<summary>
Gets the connections that the user has set up.
</summary>
<param name="options">The options to be used when sending the request.</param>
<returns>
A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.GetInviteAsync(System.String,Discord.RequestOptions)">
<summary>
Gets an invite.
</summary>
<param name="inviteId">The invitation identifier.</param>
<param name="options">The options to be used when sending the request.</param>
<returns>
A task that represents the asynchronous get operation. The task result contains the invite information.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.GetStickerAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
<summary>
Gets a sticker.
</summary>
<param name="mode">Whether or not to allow downloading from the api.</param>
<param name="id">The id of the sticker to get.</param>
<param name="options">The options to be used when sending the request.</param>
<returns>
A <see cref="T:Discord.WebSocket.SocketSticker"/> if found, otherwise <see langword="null"/>.
</returns>
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetInviteAsync(System.String,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetUserAsync(System.String,System.String,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ChannelCreated">
<summary> Fired when a channel is created. </summary>
<remarks>
<para>
This event is fired when a generic channel has been created. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketChannel"/> as its parameter.
</para>
<para>
The newly created channel is passed into the event handler parameter. The given channel type may
include, but not limited to, Private Channels (DM, Group), Guild Channels (Text, Voice, Category);
see the derived classes of <see cref="T:Discord.WebSocket.SocketChannel"/> for more details.
</para>
</remarks>
<example>
<code language="cs" region="ChannelCreated"
source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs"/>
</example>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ChannelDestroyed">
<summary> Fired when a channel is destroyed. </summary>
<remarks>
<para>
This event is fired when a generic channel has been destroyed. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketChannel"/> as its parameter.
</para>
<para>
The destroyed channel is passed into the event handler parameter. The given channel type may
include, but not limited to, Private Channels (DM, Group), Guild Channels (Text, Voice, Category);
see the derived classes of <see cref="T:Discord.WebSocket.SocketChannel"/> for more details.
</para>
</remarks>
<example>
<code language="cs" region="ChannelDestroyed"
source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs"/>
</example>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ChannelUpdated">
<summary> Fired when a channel is updated. </summary>
<remarks>
<para>
This event is fired when a generic channel has been updated. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept 2 <see cref="T:Discord.WebSocket.SocketChannel"/> as its parameters.
</para>
<para>
The original (prior to update) channel is passed into the first <see cref="T:Discord.WebSocket.SocketChannel"/>, while
the updated channel is passed into the second. The given channel type may include, but not limited
to, Private Channels (DM, Group), Guild Channels (Text, Voice, Category); see the derived classes of
<see cref="T:Discord.WebSocket.SocketChannel"/> for more details.
</para>
</remarks>
<example>
<code language="cs" region="ChannelUpdated"
source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs"/>
</example>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.MessageReceived">
<summary> Fired when a message is received. </summary>
<remarks>
<para>
This event is fired when a message is received. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketMessage"/> as its parameter.
</para>
<para>
The message that is sent to the client is passed into the event handler parameter as
<see cref="T:Discord.WebSocket.SocketMessage"/>. This message may be a system message (i.e.
<see cref="T:Discord.WebSocket.SocketSystemMessage"/>) or a user message (i.e. <see cref="T:Discord.WebSocket.SocketUserMessage"/>. See the
derived classes of <see cref="T:Discord.WebSocket.SocketMessage"/> for more details.
</para>
</remarks>
<example>
<para>The example below checks if the newly received message contains the target user.</para>
<code language="cs" region="MessageReceived"
source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs"/>
</example>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.MessageDeleted">
<summary> Fired when a message is deleted. </summary>
<remarks>
<para>
This event is fired when a message is deleted. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.Cacheable`2"/> and
<see cref="T:Discord.WebSocket.ISocketMessageChannel"/> as its parameters.
</para>
<para>
<note type="important">
It is not possible to retrieve the message via
<see cref="M:Discord.Cacheable`2.DownloadAsync"/>; the message cannot be retrieved by Discord
after the message has been deleted.
</note>
If caching is enabled via <see cref="T:Discord.WebSocket.DiscordSocketConfig"/>, the
<see cref="T:Discord.Cacheable`2"/> entity will contain the deleted message; otherwise, in event
that the message cannot be retrieved, the snowflake ID of the message is preserved in the
<see cref="T:System.UInt64"/>.
</para>
<para>
The source channel of the removed message will be passed into the
<see cref="T:Discord.WebSocket.ISocketMessageChannel"/> parameter.
</para>
</remarks>
<example>
<code language="cs" region="MessageDeleted"
source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs" />
</example>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.MessagesBulkDeleted">
<summary> Fired when multiple messages are bulk deleted. </summary>
<remarks>
<note>
The <see cref="E:Discord.WebSocket.BaseSocketClient.MessageDeleted"/> event will not be fired for individual messages contained in this event.
</note>
<para>
This event is fired when multiple messages are bulk deleted. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept an <see cref="T:System.Collections.Generic.IReadOnlyCollection`1"/> and
<see cref="T:Discord.WebSocket.ISocketMessageChannel"/> as its parameters.
</para>
<para>
<note type="important">
It is not possible to retrieve the message via
<see cref="M:Discord.Cacheable`2.DownloadAsync"/>; the message cannot be retrieved by Discord
after the message has been deleted.
</note>
If caching is enabled via <see cref="T:Discord.WebSocket.DiscordSocketConfig"/>, the
<see cref="T:Discord.Cacheable`2"/> entity will contain the deleted message; otherwise, in event
that the message cannot be retrieved, the snowflake ID of the message is preserved in the
<see cref="T:System.UInt64"/>.
</para>
<para>
The source channel of the removed message will be passed into the
<see cref="T:Discord.WebSocket.ISocketMessageChannel"/> parameter.
</para>
</remarks>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.MessageUpdated">
<summary> Fired when a message is updated. </summary>
<remarks>
<para>
This event is fired when a message is updated. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.Cacheable`2"/>, <see cref="T:Discord.WebSocket.SocketMessage"/>,
and <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> as its parameters.
</para>
<para>
If caching is enabled via <see cref="T:Discord.WebSocket.DiscordSocketConfig"/>, the
<see cref="T:Discord.Cacheable`2"/> entity will contain the original message; otherwise, in event
that the message cannot be retrieved, the snowflake ID of the message is preserved in the
<see cref="T:System.UInt64"/>.
</para>
<para>
The updated message will be passed into the <see cref="T:Discord.WebSocket.SocketMessage"/> parameter.
</para>
<para>
The source channel of the updated message will be passed into the
<see cref="T:Discord.WebSocket.ISocketMessageChannel"/> parameter.
</para>
</remarks>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ReactionAdded">
<summary> Fired when a reaction is added to a message. </summary>
<remarks>
<para>
This event is fired when a reaction is added to a user message. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.Cacheable`2"/>, an
<see cref="T:Discord.WebSocket.ISocketMessageChannel"/>, and a <see cref="T:Discord.WebSocket.SocketReaction"/> as its parameter.
</para>
<para>
If caching is enabled via <see cref="T:Discord.WebSocket.DiscordSocketConfig"/>, the
<see cref="T:Discord.Cacheable`2"/> entity will contain the original message; otherwise, in event
that the message cannot be retrieved, the snowflake ID of the message is preserved in the
<see cref="T:System.UInt64"/>.
</para>
<para>
The source channel of the reaction addition will be passed into the
<see cref="T:Discord.WebSocket.ISocketMessageChannel"/> parameter.
</para>
<para>
The reaction that was added will be passed into the <see cref="T:Discord.WebSocket.SocketReaction"/> parameter.
</para>
<note>
When fetching the reaction from this event, a user may not be provided under
<see cref="P:Discord.WebSocket.SocketReaction.User"/>. Please see the documentation of the property for more
information.
</note>
</remarks>
<example>
<code language="cs" region="ReactionAdded"
source="..\Discord.Net.Examples\WebSocket\BaseSocketClient.Events.Examples.cs"/>
</example>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ReactionRemoved">
<summary> Fired when a reaction is removed from a message. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ReactionsCleared">
<summary> Fired when all reactions to a message are cleared. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ReactionsRemovedForEmote">
<summary>
Fired when all reactions to a message with a specific emote are removed.
</summary>
<remarks>
<para>
This event is fired when all reactions to a message with a specific emote are removed.
The event handler must return a <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> and
a <see cref="T:Discord.IEmote"/> as its parameters.
</para>
<para>
The channel where this message was sent will be passed into the <see cref="T:Discord.WebSocket.ISocketMessageChannel"/> parameter.
</para>
<para>
The emoji that all reactions had and were removed will be passed into the <see cref="T:Discord.IEmote"/> parameter.
</para>
</remarks>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.RoleCreated">
<summary> Fired when a role is created. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.RoleDeleted">
<summary> Fired when a role is deleted. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.RoleUpdated">
<summary> Fired when a role is updated. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.JoinedGuild">
<summary> Fired when the connected account joins a guild. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.LeftGuild">
<summary> Fired when the connected account leaves a guild. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildAvailable">
<summary> Fired when a guild becomes available. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildUnavailable">
<summary> Fired when a guild becomes unavailable. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildMembersDownloaded">
<summary> Fired when offline guild members are downloaded. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildUpdated">
<summary> Fired when a guild is updated. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildJoinRequestDeleted">
<summary>Fired when a user leaves without agreeing to the member screening </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildScheduledEventCreated">
<summary>
Fired when a guild event is created.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildScheduledEventUpdated">
<summary>
Fired when a guild event is updated.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildScheduledEventCancelled">
<summary>
Fired when a guild event is cancelled.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildScheduledEventCompleted">
<summary>
Fired when a guild event is completed.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildScheduledEventStarted">
<summary>
Fired when a guild event is started.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.IntegrationCreated">
<summary> Fired when an integration is created. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.IntegrationUpdated">
<summary> Fired when an integration is updated. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.IntegrationDeleted">
<summary> Fired when an integration is deleted. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.UserJoined">
<summary> Fired when a user joins a guild. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.UserLeft">
<summary> Fired when a user leaves a guild. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.UserBanned">
<summary> Fired when a user is banned from a guild. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.UserUnbanned">
<summary> Fired when a user is unbanned from a guild. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.UserUpdated">
<summary> Fired when a user is updated. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildMemberUpdated">
<summary> Fired when a guild member is updated. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.UserVoiceStateUpdated">
<summary> Fired when a user joins, leaves, or moves voice channels. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.VoiceServerUpdated">
<summary> Fired when the bot connects to a Discord voice server. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.CurrentUserUpdated">
<summary> Fired when the connected account is updated. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.UserIsTyping">
<summary> Fired when a user starts typing. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.RecipientAdded">
<summary> Fired when a user joins a group channel. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.RecipientRemoved">
<summary> Fired when a user is removed from a group channel. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.PresenceUpdated">
<summary> Fired when a users presence is updated. </summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.InviteCreated">
<summary>
Fired when an invite is created.
</summary>
<remarks>
<para>
This event is fired when an invite is created. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketInvite"/> as its parameter.
</para>
<para>
The invite created will be passed into the <see cref="T:Discord.WebSocket.SocketInvite"/> parameter.
</para>
</remarks>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.InviteDeleted">
<summary>
Fired when an invite is deleted.
</summary>
<remarks>
<para>
This event is fired when an invite is deleted. The event handler must return
a <see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketGuildChannel"/> and
<see cref="T:System.String"/> as its parameter.
</para>
<para>
The channel where this invite was created will be passed into the <see cref="T:Discord.WebSocket.SocketGuildChannel"/> parameter.
</para>
<para>
The code of the deleted invite will be passed into the <see cref="T:System.String"/> parameter.
</para>
</remarks>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.InteractionCreated">
<summary>
Fired when an Interaction is created. This event covers all types of interactions including but not limited to: buttons, select menus, slash commands, autocompletes.
</summary>
<remarks>
<para>
This event is fired when an interaction is created. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketInteraction"/> as its parameter.
</para>
<para>
The interaction created will be passed into the <see cref="T:Discord.WebSocket.SocketInteraction"/> parameter.
</para>
</remarks>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ButtonExecuted">
<summary>
Fired when a button is clicked and its interaction is received.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.SelectMenuExecuted">
<summary>
Fired when a select menu is used and its interaction is received.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.SlashCommandExecuted">
<summary>
Fired when a slash command is used and its interaction is received.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.UserCommandExecuted">
<summary>
Fired when a user command is used and its interaction is received.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.MessageCommandExecuted">
<summary>
Fired when a message command is used and its interaction is received.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.AutocompleteExecuted">
<summary>
Fired when an autocomplete is used and its interaction is received.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ModalSubmitted">
<summary>
Fired when a modal is submitted.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ApplicationCommandCreated">
<summary>
Fired when a guild application command is created.
</summary>
<remarks>
<para>
This event is fired when an application command is created. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> as its parameter.
</para>
<para>
The command that was deleted will be passed into the <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> parameter.
</para>
<note>
<b>This event is an undocumented discord event and may break at any time, its not recommended to rely on this event</b>
</note>
</remarks>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ApplicationCommandUpdated">
<summary>
Fired when a guild application command is updated.
</summary>
<remarks>
<para>
This event is fired when an application command is updated. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> as its parameter.
</para>
<para>
The command that was deleted will be passed into the <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> parameter.
</para>
<note>
<b>This event is an undocumented discord event and may break at any time, its not recommended to rely on this event</b>
</note>
</remarks>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ApplicationCommandDeleted">
<summary>
Fired when a guild application command is deleted.
</summary>
<remarks>
<para>
This event is fired when an application command is deleted. The event handler must return a
<see cref="T:System.Threading.Tasks.Task"/> and accept a <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> as its parameter.
</para>
<para>
The command that was deleted will be passed into the <see cref="T:Discord.WebSocket.SocketApplicationCommand"/> parameter.
</para>
<note>
<b>This event is an undocumented discord event and may break at any time, its not recommended to rely on this event</b>
</note>
</remarks>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ThreadCreated">
<summary>
Fired when a thread is created within a guild, or when the current user is added to a thread.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ThreadUpdated">
<summary>
Fired when a thread is updated within a guild.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ThreadDeleted">
<summary>
Fired when a thread is deleted.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ThreadMemberJoined">
<summary>
Fired when a user joins a thread
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.ThreadMemberLeft">
<summary>
Fired when a user leaves a thread
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.StageStarted">
<summary>
Fired when a stage is started.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.StageEnded">
<summary>
Fired when a stage ends.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.StageUpdated">
<summary>
Fired when a stage is updated.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.RequestToSpeak">
<summary>
Fired when a user requests to speak within a stage channel.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.SpeakerAdded">
<summary>
Fired when a speaker is added in a stage channel.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.SpeakerRemoved">
<summary>
Fired when a speaker is removed from a stage channel.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildStickerCreated">
<summary>
Fired when a sticker in a guild is created.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildStickerUpdated">
<summary>
Fired when a sticker in a guild is updated.
</summary>
</member>
<member name="E:Discord.WebSocket.BaseSocketClient.GuildStickerDeleted">
<summary>
Fired when a sticker in a guild is deleted.