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

271
docs/api/Discord.Rest.BaseDiscordClient.html
View file

@ -190,8 +190,7 @@
</span>
<a id="Discord_Rest_BaseDiscordClient_TokenType_" data-uid="Discord.Rest.BaseDiscordClient.TokenType*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_TokenType" data-uid="Discord.Rest.BaseDiscordClient.TokenType">TokenType</h4>
<div class="markdown level1 summary"><p>Gets the token type 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">
@ -238,8 +237,7 @@
</span>
<a id="Discord_Rest_BaseDiscordClient_GetRecommendedShardCountAsync_" data-uid="Discord.Rest.BaseDiscordClient.GetRecommendedShardCountAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_GetRecommendedShardCountAsync_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.GetRecommendedShardCountAsync(Discord.RequestOptions)">GetRecommendedShardCountAsync(RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets the recommended shard count as suggested by Discord.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -258,8 +256,7 @@
<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>
@ -274,9 +271,7 @@
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains an <span class="xref">System.Int32</span>
that represents the number of shards that should be used with this account.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -467,8 +462,7 @@ that represents the number of shards that should be used with this account.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_ConnectionState_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#ConnectionState*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_ConnectionState" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#ConnectionState">IDiscordClient.ConnectionState</h4>
<div class="markdown level1 summary"><p>Gets the current state of connection.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -498,8 +492,7 @@ that represents the number of shards that should be used with this account.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_CreateGuildAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CreateGuildAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -518,26 +511,22 @@ that represents the number of shards that should be used with this account.</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>
@ -552,17 +541,10 @@ that represents the number of shards that should be used with this account.</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_Rest_BaseDiscordClient_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>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
@ -588,8 +570,7 @@ that represents the number of shards that should be used with this account.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_CurrentUser_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CurrentUser*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_CurrentUser" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CurrentUser">IDiscordClient.CurrentUser</h4>
<div class="markdown level1 summary"><p>Gets the currently 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">
@ -619,8 +600,7 @@ that represents the number of shards that should be used with this account.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetApplicationInfoAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetApplicationInfoAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -639,8 +619,7 @@ that represents the number of shards that should be used with this account.</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>
@ -655,16 +634,10 @@ that represents the number of shards that should be used with this account.</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_Rest_BaseDiscordClient_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_Rest_BaseDiscordClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.Rest.BaseDiscordClient.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>
@ -674,8 +647,7 @@ the Developer Portal.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetChannelAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetChannelAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -694,20 +666,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>
@ -722,9 +691,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>
@ -737,8 +704,7 @@ with the snowflake identifier; <code>null</code> when the channel cannot be foun
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetConnectionsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetConnectionsAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetConnectionsAsync_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -757,8 +723,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>
@ -773,8 +738,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>
@ -787,8 +751,7 @@ with the snowflake identifier; <code>null</code> when the channel cannot be foun
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetDMChannelsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetDMChannelsAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetDMChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetDMChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetDMChannelsAsync(CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a collection of direct message 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">
@ -807,14 +770,12 @@ with the snowflake identifier; <code>null</code> when the channel cannot be foun
<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>
@ -829,19 +790,10 @@ 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.IDMChannel.html">IDMChannel</a>&gt;&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
of direct-message channels that the user currently partakes in.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetDMChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method returns a collection of currently opened direct message channels.</p>
<div class="WARNING"><h5>warning</h5><p>
This method will not return previously opened DM 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_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGroupChannelsAsync_Discord_CacheMode_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.Rest.BaseDiscordClient.Discord%23IDiscordClient%23GetGroupChannelsAsync(Discord.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>
@ -851,8 +803,7 @@ of direct-message channels that the user currently partakes in.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGroupChannelsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGroupChannelsAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGroupChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGroupChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGroupChannelsAsync(CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a collection of group 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">
@ -871,14 +822,12 @@ of direct-message channels that the user currently partakes 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>
@ -893,19 +842,10 @@ of direct-message channels that the user currently partakes 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.IGroupChannel.html">IGroupChannel</a>&gt;&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
of group channels that the user currently partakes in.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGroupChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method returns a collection of currently opened group channels.</p>
<div class="WARNING"><h5>warning</h5><p>
This method will not return previously opened group 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_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGuildAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.Rest.BaseDiscordClient.Discord%23IDiscordClient%23GetGuildAsync(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>
@ -915,8 +855,7 @@ of group channels that the user currently partakes in.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGuildAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGuildAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGuildAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -935,20 +874,17 @@ of group channels that the user currently partakes in.</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>
<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>
@ -963,9 +899,7 @@ of group channels that the user currently partakes in.</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 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>
@ -978,8 +912,7 @@ with the snowflake identifier; <code>null</code> when the guild cannot be found.
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGuildsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGuildsAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGuildsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -998,14 +931,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>
@ -1020,9 +951,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>
@ -1035,8 +964,7 @@ of guilds that the current user is in.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetInviteAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetInviteAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetInviteAsync_System_String_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -1055,14 +983,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>
@ -1077,8 +1003,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>
@ -1091,8 +1016,7 @@ of guilds that the current user is in.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetPrivateChannelsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetPrivateChannelsAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -1111,14 +1035,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>
@ -1133,20 +1055,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_Rest_BaseDiscordClient_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_Rest_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.Rest.BaseDiscordClient.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>
@ -1156,8 +1068,7 @@ are currently opened in this session.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetUserAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -1176,20 +1087,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>
@ -1204,9 +1112,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>
@ -1219,8 +1125,7 @@ the name and the discriminator; <code>null</code> if the user is not found.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetUserAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -1239,20 +1144,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>
@ -1267,9 +1169,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>
@ -1282,8 +1182,7 @@ the snowflake identifier; <code>null</code> if the user is not found.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetVoiceRegionAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetVoiceRegionAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetVoiceRegionAsync_System_String_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -1302,14 +1201,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>
@ -1324,9 +1221,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>
@ -1339,8 +1234,7 @@ associated with the identifier; <code>null</code> if the voice region is not fou
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetVoiceRegionsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetVoiceRegionsAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetVoiceRegionsAsync_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.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">
@ -1359,8 +1253,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>
@ -1375,9 +1268,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>
@ -1390,8 +1281,7 @@ with all of the available voice regions in this session.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetWebhookAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetWebhookAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetWebhookAsync_System_UInt64_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">IDiscordClient.GetWebhookAsync(UInt64, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a webhook available.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1410,14 +1300,12 @@ with all of the available voice regions in this session.</p>
<tr>
<td><span class="xref">System.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td><p>The identifier of the webhook.</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>
@ -1432,9 +1320,7 @@ with all of the available voice regions in this session.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IWebhook.html">IWebhook</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains a webhook associated
with the identifier; <code>null</code> if the webhook is not found.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -1447,8 +1333,7 @@ with the identifier; <code>null</code> if the webhook is not found.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StartAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StartAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StartAsync" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StartAsync">IDiscordClient.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">
@ -1465,18 +1350,10 @@ with the identifier; <code>null</code> if the webhook is not 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 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_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_Rest_BaseDiscordClient_Discord_IDiscordClient_StopAsync.md&amp;value=---%0Auid%3A%20Discord.Rest.BaseDiscordClient.Discord%23IDiscordClient%23StopAsync%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>
@ -1486,8 +1363,7 @@ with the identifier; <code>null</code> if the webhook is not found.</p>
</span>
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StopAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StopAsync*"></a>
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StopAsync" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StopAsync">IDiscordClient.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">
@ -1504,8 +1380,7 @@ with the identifier; <code>null</code> if the webhook is not 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>