ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Discord.WebSocket.DiscordSocketRestClient.html
goat 0a227fd2b7 docs: regenerate
2020-03-24 03:22:08 +09:00

392 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class DiscordSocketRestClient
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class DiscordSocketRestClient
">
<meta name="generator" content="docfx 2.48.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Discord.WebSocket.DiscordSocketRestClient">
<h1 id="Discord_WebSocket_DiscordSocketRestClient" data-uid="Discord.WebSocket.DiscordSocketRestClient" class="text-break">Class DiscordSocketRestClient
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="Discord.Rest.BaseDiscordClient.html">BaseDiscordClient</a></div>
<div class="level2"><a class="xref" href="Discord.Rest.DiscordRestClient.html">DiscordRestClient</a></div>
<div class="level3"><span class="xref">DiscordSocketRestClient</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Discord.IDiscordClient.html">IDiscordClient</a></div>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_CurrentUser">DiscordRestClient.CurrentUser</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetApplicationInfoAsync_Discord_RequestOptions_">DiscordRestClient.GetApplicationInfoAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetChannelAsync_System_UInt64_Discord_RequestOptions_">DiscordRestClient.GetChannelAsync(UInt64, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetPrivateChannelsAsync_Discord_RequestOptions_">DiscordRestClient.GetPrivateChannelsAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetDMChannelsAsync_Discord_RequestOptions_">DiscordRestClient.GetDMChannelsAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetGroupChannelsAsync_Discord_RequestOptions_">DiscordRestClient.GetGroupChannelsAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetConnectionsAsync_Discord_RequestOptions_">DiscordRestClient.GetConnectionsAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetInviteAsync_System_String_Discord_RequestOptions_">DiscordRestClient.GetInviteAsync(String, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetGuildAsync_System_UInt64_Discord_RequestOptions_">DiscordRestClient.GetGuildAsync(UInt64, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetGuildEmbedAsync_System_UInt64_Discord_RequestOptions_">DiscordRestClient.GetGuildEmbedAsync(UInt64, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetGuildSummariesAsync_Discord_RequestOptions_">DiscordRestClient.GetGuildSummariesAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetGuildSummariesAsync_System_UInt64_System_Int32_Discord_RequestOptions_">DiscordRestClient.GetGuildSummariesAsync(UInt64, Int32, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetGuildsAsync_Discord_RequestOptions_">DiscordRestClient.GetGuildsAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions_">DiscordRestClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetUserAsync_System_UInt64_Discord_RequestOptions_">DiscordRestClient.GetUserAsync(UInt64, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetGuildUserAsync_System_UInt64_System_UInt64_Discord_RequestOptions_">DiscordRestClient.GetGuildUserAsync(UInt64, UInt64, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetVoiceRegionsAsync_Discord_RequestOptions_">DiscordRestClient.GetVoiceRegionsAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetVoiceRegionAsync_System_String_Discord_RequestOptions_">DiscordRestClient.GetVoiceRegionAsync(String, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetWebhookAsync_System_UInt64_Discord_RequestOptions_">DiscordRestClient.GetWebhookAsync(UInt64, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetApplicationInfoAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetDMChannelsAsync_Discord_CacheMode_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetDMChannelsAsync(CacheMode, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetGroupChannelsAsync_Discord_CacheMode_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetGroupChannelsAsync(CacheMode, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetConnectionsAsync_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetConnectionsAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetInviteAsync_System_String_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetInviteAsync(String, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetGuildAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetGuildsAsync_Discord_CacheMode_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetVoiceRegionsAsync_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetVoiceRegionsAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetVoiceRegionAsync_System_String_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetWebhookAsync_System_UInt64_Discord_RequestOptions_">DiscordRestClient.IDiscordClient.GetWebhookAsync(UInt64, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_Log">BaseDiscordClient.Log</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_LoggedIn">BaseDiscordClient.LoggedIn</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_LoggedOut">BaseDiscordClient.LoggedOut</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_LoginState">BaseDiscordClient.LoginState</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_TokenType">BaseDiscordClient.TokenType</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_Dispose">BaseDiscordClient.Dispose()</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_GetRecommendedShardCountAsync_Discord_RequestOptions_">BaseDiscordClient.GetRecommendedShardCountAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_ConnectionState">BaseDiscordClient.IDiscordClient.ConnectionState</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_CurrentUser">BaseDiscordClient.IDiscordClient.CurrentUser</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_">BaseDiscordClient.IDiscordClient.GetUserAsync(String, String, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StartAsync">BaseDiscordClient.IDiscordClient.StartAsync()</a>
</div>
<div>
<a class="xref" href="Discord.Rest.BaseDiscordClient.html#Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StopAsync">BaseDiscordClient.IDiscordClient.StopAsync()</a>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Discord.WebSocket.html">Discord.WebSocket</a></h6>
<h6><strong>Assembly</strong>: Discord.Net.WebSocket.dll</h6>
<h5 id="Discord_WebSocket_DiscordSocketRestClient_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class DiscordSocketRestClient : DiscordRestClient, IDiscordClient, IDisposable</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<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_DiscordSocketRestClient_LoginAsync_Discord_TokenType_System_String_System_Boolean_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketRestClient.LoginAsync(Discord.TokenType%2CSystem.String%2CSystem.Boolean)%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketRestClient.cs/#L11">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketRestClient_LoginAsync_" data-uid="Discord.WebSocket.DiscordSocketRestClient.LoginAsync*"></a>
<h4 id="Discord_WebSocket_DiscordSocketRestClient_LoginAsync_Discord_TokenType_System_String_System_Boolean_" data-uid="Discord.WebSocket.DiscordSocketRestClient.LoginAsync(Discord.TokenType,System.String,System.Boolean)">LoginAsync(TokenType, String, Boolean)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task LoginAsync(TokenType tokenType, string token, bool validateToken = true)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.TokenType.html">TokenType</a></td>
<td><span class="parametername">tokenType</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">token</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">validateToken</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td></td>
</tr>
</tbody>
</table>
<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_DiscordSocketRestClient_LogoutAsync.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketRestClient.LogoutAsync%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketRestClient.cs/#L15">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketRestClient_LogoutAsync_" data-uid="Discord.WebSocket.DiscordSocketRestClient.LogoutAsync*"></a>
<h4 id="Discord_WebSocket_DiscordSocketRestClient_LogoutAsync" data-uid="Discord.WebSocket.DiscordSocketRestClient.LogoutAsync">LogoutAsync()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task LogoutAsync()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Discord.IDiscordClient.html">IDiscordClient</a>
</div>
<div>
<span class="xref">System.IDisposable</span>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketRestClient.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketRestClient%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketRestClient.cs/#L7" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink