ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-15 05:04:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: regenerate

Browse source
This commit is contained in:
goat 2020-05-14 22:49:06 +02:00
parent 39a7afa4b6
commit 94571bb41b
71 changed files with 3254 additions and 7339 deletions
Download patch file Download diff file Expand all files Collapse all files

389
docs/api/Discord.WebSocket.DiscordShardedClient.html
View file

@ -406,8 +406,7 @@
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Activity_" data-uid="Discord.WebSocket.DiscordShardedClient.Activity*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Activity" data-uid="Discord.WebSocket.DiscordShardedClient.Activity">Activity</h4>
<div class="markdown level1 summary"><p>Gets the activity for the logged-in user.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -424,8 +423,7 @@
<tbody>
<tr>
<td><a class="xref" href="Discord.IActivity.html">IActivity</a></td>
<td><p>An activity object that represents the user's current activity.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -440,8 +438,7 @@
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Guilds_" data-uid="Discord.WebSocket.DiscordShardedClient.Guilds*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Guilds" data-uid="Discord.WebSocket.DiscordShardedClient.Guilds">Guilds</h4>
<div class="markdown level1 summary"><p>Gets a collection of guilds that the user is currently in.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -458,8 +455,7 @@
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.WebSocket.SocketGuild.html">SocketGuild</a>&gt;</td>
<td><p>A read-only collection of guilds that the current user is in.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -474,8 +470,7 @@
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Latency_" data-uid="Discord.WebSocket.DiscordShardedClient.Latency*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Latency" data-uid="Discord.WebSocket.DiscordShardedClient.Latency">Latency</h4>
<div class="markdown level1 summary"><p>Gets the estimated round-trip latency, in milliseconds, to the gateway server.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -492,9 +487,7 @@
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><p>An <span class="xref">System.Int32</span> that represents the round-trip latency to the WebSocket server. Please
note that this value does not represent a &quot;true&quot; latency for operations such as sending a message.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -509,8 +502,7 @@ note that this value does not represent a &quot;true&quot; latency for operation
</span>
<a id="Discord_WebSocket_DiscordShardedClient_PrivateChannels_" data-uid="Discord.WebSocket.DiscordShardedClient.PrivateChannels*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_PrivateChannels" data-uid="Discord.WebSocket.DiscordShardedClient.PrivateChannels">PrivateChannels</h4>
<div class="markdown level1 summary"><p>Gets a collection of private channels opened in this session.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -527,21 +519,12 @@ note that this value does not represent a &quot;true&quot; latency for operation
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.WebSocket.ISocketPrivateChannel.html">ISocketPrivateChannel</a>&gt;</td>
<td><p>A read-only collection of private channels that the user currently partakes in.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_PrivateChannels">BaseSocketClient.PrivateChannels</a></div>
<h5 id="Discord_WebSocket_DiscordShardedClient_PrivateChannels_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method will retrieve all private channels (including direct-message, group channel and such) that
are currently opened in this session.</p>
<div class="WARNING"><h5>warning</h5><p>
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.
</p></div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordShardedClient_Rest.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.Rest%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@ -614,8 +597,7 @@ are currently opened in this session.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Status_" data-uid="Discord.WebSocket.DiscordShardedClient.Status*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Status" data-uid="Discord.WebSocket.DiscordShardedClient.Status">Status</h4>
<div class="markdown level1 summary"><p>Gets the status for the logged-in user.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -632,8 +614,7 @@ are currently opened in this session.</p>
<tbody>
<tr>
<td><a class="xref" href="Discord.UserStatus.html">UserStatus</a></td>
<td><p>A status object that represents the user's online presence status.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -648,8 +629,7 @@ are currently opened in this session.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_VoiceRegions_" data-uid="Discord.WebSocket.DiscordShardedClient.VoiceRegions*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_VoiceRegions" data-uid="Discord.WebSocket.DiscordShardedClient.VoiceRegions">VoiceRegions</h4>
<div class="markdown level1 summary"><p>Gets a collection of available voice regions.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -666,8 +646,7 @@ are currently opened in this session.</p>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.Rest.RestVoiceRegion.html">RestVoiceRegion</a>&gt;</td>
<td><p>A read-only collection of voice regions that the user has access to.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -684,8 +663,7 @@ are currently opened in this session.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_DownloadUsersAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.DownloadUsersAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_DownloadUsersAsync_System_Collections_Generic_IEnumerable_Discord_IGuild__" data-uid="Discord.WebSocket.DiscordShardedClient.DownloadUsersAsync(System.Collections.Generic.IEnumerable{Discord.IGuild})">DownloadUsersAsync(IEnumerable&lt;IGuild&gt;)</h4>
<div class="markdown level1 summary"><p>Attempts to download users into the user cache for the selected guilds.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -704,8 +682,7 @@ are currently opened in this session.</p>
<tr>
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Discord.IGuild.html">IGuild</a>&gt;</td>
<td><span class="parametername">guilds</span></td>
<td><p>The guilds to download the members from.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -720,8 +697,7 @@ are currently opened in this session.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous download operation.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -752,8 +728,7 @@ are currently opened in this session.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_GetApplicationInfoAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.GetApplicationInfoAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_GetApplicationInfoAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.GetApplicationInfoAsync(Discord.RequestOptions)">GetApplicationInfoAsync(RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a Discord application information for the logged-in user.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -772,8 +747,7 @@ are currently opened in this session.</p>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -788,18 +762,12 @@ are currently opened in this session.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.Rest.RestApplication.html">RestApplication</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains the application
information.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_GetApplicationInfoAsync_Discord_RequestOptions_">BaseSocketClient.GetApplicationInfoAsync(RequestOptions)</a></div>
<h5 id="Discord_WebSocket_DiscordShardedClient_GetApplicationInfoAsync_Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method reflects your application information you submitted when creating a Discord application via
the Developer Portal.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordShardedClient_GetChannel_System_UInt64_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.GetChannel(System.UInt64)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@ -809,8 +777,7 @@ the Developer Portal.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_GetChannel_" data-uid="Discord.WebSocket.DiscordShardedClient.GetChannel*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_GetChannel_System_UInt64_" data-uid="Discord.WebSocket.DiscordShardedClient.GetChannel(System.UInt64)">GetChannel(UInt64)</h4>
<div class="markdown level1 summary"><p>Gets a channel.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -829,8 +796,7 @@ the Developer Portal.</p>
<tr>
<td><span class="xref">System.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td><p>The snowflake identifier of the channel (e.g. <code>381889909113225237</code>).</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -845,9 +811,7 @@ the Developer Portal.</p>
<tbody>
<tr>
<td><a class="xref" href="Discord.WebSocket.SocketChannel.html">SocketChannel</a></td>
<td><p>A generic WebSocket-based channel object (voice, text, category, etc.) associated with the identifier;
<code>null</code> when the channel cannot be found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -862,8 +826,7 @@ the Developer Portal.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_GetGuild_" data-uid="Discord.WebSocket.DiscordShardedClient.GetGuild*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_GetGuild_System_UInt64_" data-uid="Discord.WebSocket.DiscordShardedClient.GetGuild(System.UInt64)">GetGuild(UInt64)</h4>
<div class="markdown level1 summary"><p>Gets a guild.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -882,8 +845,7 @@ the Developer Portal.</p>
<tr>
<td><span class="xref">System.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td><p>The guild snowflake identifier.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -898,9 +860,7 @@ the Developer Portal.</p>
<tbody>
<tr>
<td><a class="xref" href="Discord.WebSocket.SocketGuild.html">SocketGuild</a></td>
<td><p>A WebSocket-based guild associated with the snowflake identifier; <code>null</code> when the guild cannot be
found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1056,8 +1016,7 @@ found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_GetUser_" data-uid="Discord.WebSocket.DiscordShardedClient.GetUser*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_GetUser_System_String_System_String_" data-uid="Discord.WebSocket.DiscordShardedClient.GetUser(System.String,System.String)">GetUser(String, String)</h4>
<div class="markdown level1 summary"><p>Gets a user.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1076,14 +1035,12 @@ found.</p>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">username</span></td>
<td><p>The name of the user.</p>
</td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">discriminator</span></td>
<td><p>The discriminator value of the user.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1098,27 +1055,12 @@ found.</p>
<tbody>
<tr>
<td><a class="xref" href="Discord.WebSocket.SocketUser.html">SocketUser</a></td>
<td><p>A generic WebSocket-based user; <code>null</code> when the user cannot be found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_GetUser_System_String_System_String_">BaseSocketClient.GetUser(String, String)</a></div>
<h5 id="Discord_WebSocket_DiscordShardedClient_GetUser_System_String_System_String__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method gets the user present in the WebSocket cache with the given condition.</p>
<div class="WARNING"><h5>warning</h5><p>
Sometimes a user may return <code>null</code> 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 <a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_AlwaysDownloadUsers">AlwaysDownloadUsers</a>.
</p></div>
<div class="NOTE"><h5>note</h5><p>
This method does not attempt to fetch users that the logged-in user does not have access to (i.e.
users who don&apos;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
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetUserAsync_System_UInt64_Discord_RequestOptions_">GetUserAsync(UInt64, RequestOptions)</a>.
</p></div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordShardedClient_GetUser_System_UInt64_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.GetUser(System.UInt64)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@ -1128,8 +1070,7 @@ found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_GetUser_" data-uid="Discord.WebSocket.DiscordShardedClient.GetUser*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_GetUser_System_UInt64_" data-uid="Discord.WebSocket.DiscordShardedClient.GetUser(System.UInt64)">GetUser(UInt64)</h4>
<div class="markdown level1 summary"><p>Gets a generic user.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1148,8 +1089,7 @@ found.</p>
<tr>
<td><span class="xref">System.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td><p>The user snowflake ID.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1164,27 +1104,12 @@ found.</p>
<tbody>
<tr>
<td><a class="xref" href="Discord.WebSocket.SocketUser.html">SocketUser</a></td>
<td><p>A generic WebSocket-based user; <code>null</code> when the user cannot be found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_GetUser_System_UInt64_">BaseSocketClient.GetUser(UInt64)</a></div>
<h5 id="Discord_WebSocket_DiscordShardedClient_GetUser_System_UInt64__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method gets the user present in the WebSocket cache with the given condition.</p>
<div class="WARNING"><h5>warning</h5><p>
Sometimes a user may return <code>null</code> 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 <a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_AlwaysDownloadUsers">AlwaysDownloadUsers</a>.
</p></div>
<div class="NOTE"><h5>note</h5><p>
This method does not attempt to fetch users that the logged-in user does not have access to (i.e.
users who don&apos;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
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetUserAsync_System_UInt64_Discord_RequestOptions_">GetUserAsync(UInt64, RequestOptions)</a>.
</p></div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordShardedClient_GetVoiceRegion_System_String_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.GetVoiceRegion(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@ -1194,8 +1119,7 @@ found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_GetVoiceRegion_" data-uid="Discord.WebSocket.DiscordShardedClient.GetVoiceRegion*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_GetVoiceRegion_System_String_" data-uid="Discord.WebSocket.DiscordShardedClient.GetVoiceRegion(System.String)">GetVoiceRegion(String)</h4>
<div class="markdown level1 summary"><p>Gets a voice region.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1214,8 +1138,7 @@ found.</p>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">id</span></td>
<td><p>The identifier of the voice region (e.g. <code>eu-central</code> ).</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1230,9 +1153,7 @@ found.</p>
<tbody>
<tr>
<td><a class="xref" href="Discord.Rest.RestVoiceRegion.html">RestVoiceRegion</a></td>
<td><p>A REST-based voice region associated with the identifier; <code>null</code> if the voice region is not
found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1247,8 +1168,7 @@ found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_SetActivityAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.SetActivityAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_SetActivityAsync_Discord_IActivity_" data-uid="Discord.WebSocket.DiscordShardedClient.SetActivityAsync(Discord.IActivity)">SetActivityAsync(IActivity)</h4>
<div class="markdown level1 summary"><p>Sets the <code data-dev-comment-type="paramref" class="paramref">activity</code> of the logged-in user.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1267,8 +1187,7 @@ found.</p>
<tr>
<td><a class="xref" href="Discord.IActivity.html">IActivity</a></td>
<td><span class="parametername">activity</span></td>
<td><p>The activity to be set.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1283,23 +1202,12 @@ found.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous set operation.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_SetActivityAsync_Discord_IActivity_">BaseSocketClient.SetActivityAsync(IActivity)</a></div>
<h5 id="Discord_WebSocket_DiscordShardedClient_SetActivityAsync_Discord_IActivity__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method sets the <code data-dev-comment-type="paramref" class="paramref">activity</code> of the user.</p>
<div class="NOTE"><h5>note</h5><p>
Discord will only accept setting of name and the type of activity.
</p></div>
<div class="WARNING"><h5>warning</h5><p>
Rich Presence cannot be set via this method or client. Rich Presence is strictly limited to RPC
clients only.
</p></div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordShardedClient_SetGameAsync_System_String_System_String_Discord_ActivityType_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.SetGameAsync(System.String%2CSystem.String%2CDiscord.ActivityType)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@ -1309,8 +1217,7 @@ found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_SetGameAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.SetGameAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_SetGameAsync_System_String_System_String_Discord_ActivityType_" data-uid="Discord.WebSocket.DiscordShardedClient.SetGameAsync(System.String,System.String,Discord.ActivityType)">SetGameAsync(String, String, ActivityType)</h4>
<div class="markdown level1 summary"><p>Sets the game of the user.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1329,20 +1236,17 @@ found.</p>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>The name of the game.</p>
</td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">streamUrl</span></td>
<td><p>If streaming, the URL of the stream. Must be a valid Twitch URL.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.ActivityType.html">ActivityType</a></td>
<td><span class="parametername">type</span></td>
<td><p>The type of the game.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1357,8 +1261,7 @@ found.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous set operation.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1373,8 +1276,7 @@ found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_SetStatusAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.SetStatusAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_SetStatusAsync_Discord_UserStatus_" data-uid="Discord.WebSocket.DiscordShardedClient.SetStatusAsync(Discord.UserStatus)">SetStatusAsync(UserStatus)</h4>
<div class="markdown level1 summary"><p>Sets the current status of the user (e.g. Online, Do not Disturb).</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1393,8 +1295,7 @@ found.</p>
<tr>
<td><a class="xref" href="Discord.UserStatus.html">UserStatus</a></td>
<td><span class="parametername">status</span></td>
<td><p>The new status to be set.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1409,8 +1310,7 @@ found.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous set operation.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1425,8 +1325,7 @@ found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_StartAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.StartAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_StartAsync" data-uid="Discord.WebSocket.DiscordShardedClient.StartAsync">StartAsync()</h4>
<div class="markdown level1 summary"><p>Starts the connection between Discord and the client..</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1443,20 +1342,12 @@ found.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous start operation.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_StartAsync">BaseSocketClient.StartAsync()</a></div>
<h5 id="Discord_WebSocket_DiscordShardedClient_StartAsync_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method will initialize the connection between the client and Discord.</p>
<div class="IMPORTANT"><h5>important</h5><p>
This method will immediately return after it is called, as it will initialize the connection on
another thread.
</p></div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordShardedClient_StopAsync.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.StopAsync%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@ -1466,8 +1357,7 @@ found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_StopAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.StopAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_StopAsync" data-uid="Discord.WebSocket.DiscordShardedClient.StopAsync">StopAsync()</h4>
<div class="markdown level1 summary"><p>Stops the connection between Discord and the client.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1484,8 +1374,7 @@ found.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous stop operation.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1624,8 +1513,7 @@ found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_CreateGuildAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#CreateGuildAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Creates a guild for the logged-in user who is in less than 10 active guilds.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1644,26 +1532,22 @@ found.</p>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>The name of the new guild.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a></td>
<td><span class="parametername">region</span></td>
<td><p>The voice region to create the guild with.</p>
</td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.IO.Stream</span></td>
<td><span class="parametername">jpegIcon</span></td>
<td><p>The icon of the guild.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1678,17 +1562,10 @@ found.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IGuild.html">IGuild</a>&gt;</td>
<td><p>A task that represents the asynchronous creation operation. The task result contains the created guild.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method creates a new guild on behalf of the logged-in user.</p>
<div class="WARNING"><h5>warning</h5><p>
Due to Discord&apos;s limitation, this method will only work for users that are in less than 10 guilds.
</p></div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.Discord%23IDiscordClient%23GetApplicationInfoAsync(Discord.RequestOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@ -1698,8 +1575,7 @@ found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetApplicationInfoAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetApplicationInfoAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">IDiscordClient.GetApplicationInfoAsync(RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a Discord application information for the logged-in user.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1718,8 +1594,7 @@ found.</p>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1734,16 +1609,10 @@ found.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IApplication.html">IApplication</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains the application
information.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method reflects your application information you submitted when creating a Discord application via
the Developer Portal.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.Discord%23IDiscordClient%23GetChannelAsync(System.UInt64%2CDiscord.CacheMode%2CDiscord.RequestOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@ -1753,8 +1622,7 @@ the Developer Portal.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetChannelAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetChannelAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a generic channel.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1773,20 +1641,17 @@ the Developer Portal.</p>
<tr>
<td><span class="xref">System.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td><p>The snowflake identifier of the channel (e.g. <code>381889909113225237</code>).</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
<td><span class="parametername">mode</span></td>
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1801,9 +1666,7 @@ the Developer Portal.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IChannel.html">IChannel</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains the channel associated
with the snowflake identifier; <code>null</code> when the channel cannot be found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1816,8 +1679,7 @@ with the snowflake identifier; <code>null</code> when the channel cannot be foun
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetConnectionsAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetConnectionsAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetConnectionsAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">IDiscordClient.GetConnectionsAsync(RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets the connections that the user has set up.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1836,8 +1698,7 @@ with the snowflake identifier; <code>null</code> when the channel cannot be foun
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1852,8 +1713,7 @@ with the snowflake identifier; <code>null</code> when the channel cannot be foun
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.IConnection.html">IConnection</a>&gt;&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1866,8 +1726,7 @@ with the snowflake identifier; <code>null</code> when the channel cannot be foun
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetGuildAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetGuildAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetGuildAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a guild.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1886,20 +1745,17 @@ with the snowflake identifier; <code>null</code> when the channel cannot be foun
<tr>
<td><span class="xref">System.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td><p>The guild snowflake identifier.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
<td><span class="parametername">mode</span></td>
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1914,9 +1770,7 @@ with the snowflake identifier; <code>null</code> when the channel cannot be foun
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IGuild.html">IGuild</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains the guild associated
with the snowflake identifier; <code>null</code> when the guild cannot be found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1929,8 +1783,7 @@ with the snowflake identifier; <code>null</code> when the guild cannot be found.
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetGuildsAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetGuildsAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetGuildsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a collection of guilds that the user is currently in.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1949,14 +1802,12 @@ with the snowflake identifier; <code>null</code> when the guild cannot be found.
<tr>
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
<td><span class="parametername">mode</span></td>
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1971,9 +1822,7 @@ with the snowflake identifier; <code>null</code> when the guild cannot be found.
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.IGuild.html">IGuild</a>&gt;&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
of guilds that the current user is in.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1986,8 +1835,7 @@ of guilds that the current user is in.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetInviteAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetInviteAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetInviteAsync_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetInviteAsync(System.String,Discord.RequestOptions)">IDiscordClient.GetInviteAsync(String, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets an invite.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -2006,14 +1854,12 @@ of guilds that the current user is in.</p>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">inviteId</span></td>
<td><p>The invitation identifier.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -2028,8 +1874,7 @@ of guilds that the current user is in.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IInvite.html">IInvite</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains the invite information.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -2042,8 +1887,7 @@ of guilds that the current user is in.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetPrivateChannelsAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetPrivateChannelsAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a collection of private channels opened in this session.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -2062,14 +1906,12 @@ of guilds that the current user is in.</p>
<tr>
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
<td><span class="parametername">mode</span></td>
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -2084,20 +1926,10 @@ of guilds that the current user is in.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.IPrivateChannel.html">IPrivateChannel</a>&gt;&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
of private channels that the user currently partakes in.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method will retrieve all private channels (including direct-message, group channel and such) that
are currently opened in this session.</p>
<div class="WARNING"><h5>warning</h5><p>
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.
</p></div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.Discord%23IDiscordClient%23GetUserAsync(System.String%2CSystem.String%2CDiscord.RequestOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@ -2107,8 +1939,7 @@ are currently opened in this session.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetUserAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetUserAsync(System.String,System.String,Discord.RequestOptions)">IDiscordClient.GetUserAsync(String, String, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a user.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -2127,20 +1958,17 @@ are currently opened in this session.</p>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">username</span></td>
<td><p>The name of the user (e.g. <code>Still</code>).</p>
</td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">discriminator</span></td>
<td><p>The discriminator value of the user (e.g. <code>2876</code>).</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -2155,9 +1983,7 @@ are currently opened in this session.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IUser.html">IUser</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains the user associated with
the name and the discriminator; <code>null</code> if the user is not found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -2170,8 +1996,7 @@ the name and the discriminator; <code>null</code> if the user is not found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetUserAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a user.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -2190,20 +2015,17 @@ the name and the discriminator; <code>null</code> if the user is not found.</p>
<tr>
<td><span class="xref">System.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
<td><span class="parametername">mode</span></td>
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -2218,9 +2040,7 @@ the name and the discriminator; <code>null</code> if the user is not found.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IUser.html">IUser</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains the user associated with
the snowflake identifier; <code>null</code> if the user is not found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -2233,8 +2053,7 @@ the snowflake identifier; <code>null</code> if the user is not found.</p>
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetVoiceRegionAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetVoiceRegionAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetVoiceRegionAsync_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a voice region.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -2253,14 +2072,12 @@ the snowflake identifier; <code>null</code> if the user is not found.</p>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">id</span></td>
<td><p>The identifier of the voice region (e.g. <code>eu-central</code> ).</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -2275,9 +2092,7 @@ the snowflake identifier; <code>null</code> if the user is not found.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains the voice region
associated with the identifier; <code>null</code> if the voice region is not found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -2290,8 +2105,7 @@ associated with the identifier; <code>null</code> if the voice region is not fou
</span>
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetVoiceRegionsAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetVoiceRegionsAsync*"></a>
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetVoiceRegionsAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">IDiscordClient.GetVoiceRegionsAsync(RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a collection of the available voice regions.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -2310,8 +2124,7 @@ associated with the identifier; <code>null</code> if the voice region is not fou
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -2326,9 +2139,7 @@ associated with the identifier; <code>null</code> if the voice region is not fou
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>&gt;&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
with all of the available voice regions in this session.</p>
</td>
<td></td>
</tr>
</tbody>
</table>