mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-15 05:04:15 +01:00
docs: regenerate
This commit is contained in:
goat
parent
3479919ab6
commit
31af5d8d77
88 changed files with 9028 additions and 3189 deletions
|
|
@ -406,7 +406,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the activity for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -423,7 +424,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IActivity.html">IActivity</a></td>
|
||||
<td></td>
|
||||
<td><p>An activity object that represents the user's current activity.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -438,7 +440,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of guilds that the user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -455,7 +458,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketGuild.html">SocketGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of guilds that the current user is in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -470,7 +474,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the estimated round-trip latency, in milliseconds, to the gateway server.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -487,7 +492,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></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 "true" latency for operations such as sending a message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -502,7 +509,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of private channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -519,12 +527,21 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.ISocketPrivateChannel.html">ISocketPrivateChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of private channels that the user currently partakes in.</p>
|
||||
</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&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>
|
||||
|
|
@ -597,7 +614,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the status for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -614,7 +632,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.UserStatus.html">UserStatus</a></td>
|
||||
<td></td>
|
||||
<td><p>A status object that represents the user's online presence status.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -629,7 +648,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of available voice regions.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -646,7 +666,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Rest.RestVoiceRegion.html">RestVoiceRegion</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of voice regions that the user has access to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -663,7 +684,8 @@
|
|||
</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<IGuild>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Attempts to download users into the user cache for the selected guilds.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -682,7 +704,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td><span class="parametername">guilds</span></td>
|
||||
<td></td>
|
||||
<td><p>The guilds to download the members from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -697,7 +720,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous download operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -728,7 +752,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a Discord application information for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -747,7 +772,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -762,12 +788,18 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestApplication.html">RestApplication</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the application
|
||||
information.</p>
|
||||
</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&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>
|
||||
|
|
@ -777,7 +809,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -796,7 +829,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the channel (e.g. <code>381889909113225237</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -811,7 +845,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.WebSocket.SocketChannel.html">SocketChannel</a></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -826,7 +862,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -845,7 +882,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The guild snowflake identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -860,7 +898,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.WebSocket.SocketGuild.html">SocketGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A WebSocket-based guild associated with the snowflake identifier; <code>null</code> when the guild cannot be
|
||||
found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1016,7 +1056,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1035,12 +1076,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">username</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">discriminator</span></td>
|
||||
<td></td>
|
||||
<td><p>The discriminator value of the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1055,12 +1098,27 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.WebSocket.SocketUser.html">SocketUser</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic WebSocket-based user; <code>null</code> when the user cannot be found.</p>
|
||||
</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'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&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>
|
||||
|
|
@ -1070,7 +1128,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a generic user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1089,7 +1148,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The user snowflake ID.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1104,12 +1164,27 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.WebSocket.SocketUser.html">SocketUser</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic WebSocket-based user; <code>null</code> when the user cannot be found.</p>
|
||||
</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'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&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>
|
||||
|
|
@ -1119,7 +1194,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a voice region.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1138,7 +1214,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The identifier of the voice region (e.g. <code>eu-central</code> ).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1153,7 +1230,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Rest.RestVoiceRegion.html">RestVoiceRegion</a></td>
|
||||
<td></td>
|
||||
<td><p>A REST-based voice region associated with the identifier; <code>null</code> if the voice region is not
|
||||
found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1168,7 +1247,8 @@
|
|||
</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"></div>
|
||||
<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 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1187,7 +1267,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IActivity.html">IActivity</a></td>
|
||||
<td><span class="parametername">activity</span></td>
|
||||
<td></td>
|
||||
<td><p>The activity to be set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1202,12 +1283,23 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous set operation.</p>
|
||||
</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&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>
|
||||
|
|
@ -1217,7 +1309,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Sets the game of the user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1236,17 +1329,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">name</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the game.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">streamUrl</span></td>
|
||||
<td></td>
|
||||
<td><p>If streaming, the URL of the stream. Must be a valid Twitch URL.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.ActivityType.html">ActivityType</a></td>
|
||||
<td><span class="parametername">type</span></td>
|
||||
<td></td>
|
||||
<td><p>The type of the game.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1261,7 +1357,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous set operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1276,7 +1373,8 @@
|
|||
</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"></div>
|
||||
<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 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1295,7 +1393,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.UserStatus.html">UserStatus</a></td>
|
||||
<td><span class="parametername">status</span></td>
|
||||
<td></td>
|
||||
<td><p>The new status to be set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1310,7 +1409,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous set operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1325,7 +1425,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Starts the connection between Discord and the client..</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1342,12 +1443,20 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous start operation.</p>
|
||||
</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&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>
|
||||
|
|
@ -1357,7 +1466,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Stops the connection between Discord and the client.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1374,7 +1484,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous stop operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1513,7 +1624,8 @@
|
|||
</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"></div>
|
||||
<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 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1532,22 +1644,26 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">name</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the new guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a></td>
|
||||
<td><span class="parametername">region</span></td>
|
||||
<td></td>
|
||||
<td><p>The voice region to create the guild with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><span class="parametername">jpegIcon</span></td>
|
||||
<td></td>
|
||||
<td><p>The icon of the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1562,10 +1678,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous creation operation. The task result contains the created guild.</p>
|
||||
</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'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&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>
|
||||
|
|
@ -1575,7 +1698,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a Discord application information for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1594,7 +1718,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1609,10 +1734,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IApplication.html">IApplication</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the application
|
||||
information.</p>
|
||||
</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&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>
|
||||
|
|
@ -1622,7 +1753,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a generic channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1641,17 +1773,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the channel (e.g. <code>381889909113225237</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1666,7 +1801,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IChannel.html">IChannel</a>></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1679,7 +1816,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the connections that the user has set up.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1698,7 +1836,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1713,7 +1852,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IConnection.html">IConnection</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1726,7 +1866,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1745,17 +1886,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The guild snowflake identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1770,7 +1914,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1783,7 +1929,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of guilds that the user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1802,12 +1949,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1822,7 +1971,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>>></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1835,7 +1986,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets an invite.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1854,12 +2006,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">inviteId</span></td>
|
||||
<td></td>
|
||||
<td><p>The invitation identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1874,7 +2028,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IInvite.html">IInvite</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the invite information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1887,7 +2042,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of private channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1906,12 +2062,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1926,10 +2084,20 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IPrivateChannel.html">IPrivateChannel</a>>></td>
|
||||
<td></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>
|
||||
</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&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>
|
||||
|
|
@ -1939,7 +2107,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1958,17 +2127,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">username</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the user (e.g. <code>Still</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">discriminator</span></td>
|
||||
<td></td>
|
||||
<td><p>The discriminator value of the user (e.g. <code>2876</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1983,7 +2155,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1996,7 +2170,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2015,17 +2190,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2040,7 +2218,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2053,7 +2233,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a voice region.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2072,12 +2253,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The identifier of the voice region (e.g. <code>eu-central</code> ).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2092,7 +2275,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2105,7 +2290,8 @@
|
|||
</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"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of the available voice regions.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2124,7 +2310,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2139,7 +2326,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>>></td>
|
||||
<td></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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue