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.Net.HttpException.html
goat 2584122e4e regenerate docs
2020-03-11 21:54:11 +09:00

387 lines
17 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 HttpException
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class HttpException
">
<meta name="generator" content="docfx 2.50.0.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.Net.HttpException">
<h1 id="Discord_Net_HttpException" data-uid="Discord.Net.HttpException" class="text-break">Class HttpException
</h1>
<div class="markdown level0 summary"><p>The exception that is thrown if an error occurs while processing an Discord HTTP request.</p>
</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"><span class="xref">System.Exception</span></div>
<div class="level2"><span class="xref">HttpException</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.Runtime.Serialization.ISerializable</span></div>
<div><span class="xref">System.Runtime.InteropServices._Exception</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Exception.GetBaseException()</span>
</div>
<div>
<span class="xref">System.Exception.ToString()</span>
</div>
<div>
<span class="xref">System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)</span>
</div>
<div>
<span class="xref">System.Exception.GetType()</span>
</div>
<div>
<span class="xref">System.Exception.Message</span>
</div>
<div>
<span class="xref">System.Exception.Data</span>
</div>
<div>
<span class="xref">System.Exception.InnerException</span>
</div>
<div>
<span class="xref">System.Exception.TargetSite</span>
</div>
<div>
<span class="xref">System.Exception.StackTrace</span>
</div>
<div>
<span class="xref">System.Exception.HelpLink</span>
</div>
<div>
<span class="xref">System.Exception.Source</span>
</div>
<div>
<span class="xref">System.Exception.HResult</span>
</div>
<div>
<span class="xref">System.Exception.SerializeObjectState</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.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Discord.Net.html">Discord.Net</a></h6>
<h6><strong>Assembly</strong>: Discord.Net.Core.dll</h6>
<h5 id="Discord_Net_HttpException_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class HttpException : Exception, ISerializable, _Exception</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_Net_HttpException__ctor_System_Net_HttpStatusCode_Discord_Net_IRequest_System_Nullable_System_Int32__System_String_.md&amp;value=---%0Auid%3A%20Discord.Net.HttpException.%23ctor(System.Net.HttpStatusCode%2CDiscord.Net.IRequest%2CSystem.Nullable%7BSystem.Int32%7D%2CSystem.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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Net/HttpException.cs/#L45">View Source</a>
</span>
<a id="Discord_Net_HttpException__ctor_" data-uid="Discord.Net.HttpException.#ctor*"></a>
<h4 id="Discord_Net_HttpException__ctor_System_Net_HttpStatusCode_Discord_Net_IRequest_System_Nullable_System_Int32__System_String_" data-uid="Discord.Net.HttpException.#ctor(System.Net.HttpStatusCode,Discord.Net.IRequest,System.Nullable{System.Int32},System.String)">HttpException(HttpStatusCode, IRequest, Nullable&lt;Int32&gt;, String)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Discord.Net.HttpException.html">HttpException</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public HttpException(HttpStatusCode httpCode, IRequest request, int? discordCode = default(int? ), string reason = null)</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><span class="xref">System.Net.HttpStatusCode</span></td>
<td><span class="parametername">httpCode</span></td>
<td><p>The HTTP status code returned.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.Net.IRequest.html">IRequest</a></td>
<td><span class="parametername">request</span></td>
<td><p>The request that was sent prior to the exception.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td><span class="parametername">discordCode</span></td>
<td><p>The Discord status code returned.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">reason</span></td>
<td><p>The reason behind the exception.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_Net_HttpException_DiscordCode.md&amp;value=---%0Auid%3A%20Discord.Net.HttpException.DiscordCode%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Net/HttpException.cs/#L28">View Source</a>
</span>
<a id="Discord_Net_HttpException_DiscordCode_" data-uid="Discord.Net.HttpException.DiscordCode*"></a>
<h4 id="Discord_Net_HttpException_DiscordCode" data-uid="Discord.Net.HttpException.DiscordCode">DiscordCode</h4>
<div class="markdown level1 summary"><p>Gets the JSON error code returned by Discord.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int? DiscordCode { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Nullable</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td><p>A
<a href="https://discordapp.com/developers/docs/topics/opcodes-and-status-codes#json">JSON error code</a>
from Discord, or <code>null</code> if none.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_Net_HttpException_HttpCode.md&amp;value=---%0Auid%3A%20Discord.Net.HttpException.HttpCode%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Net/HttpException.cs/#L19">View Source</a>
</span>
<a id="Discord_Net_HttpException_HttpCode_" data-uid="Discord.Net.HttpException.HttpCode*"></a>
<h4 id="Discord_Net_HttpException_HttpCode" data-uid="Discord.Net.HttpException.HttpCode">HttpCode</h4>
<div class="markdown level1 summary"><p>Gets the HTTP status code returned by Discord.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public HttpStatusCode HttpCode { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Net.HttpStatusCode</span></td>
<td><p>An
<a href="https://discordapp.com/developers/docs/topics/opcodes-and-status-codes#http">HTTP status code</a>
from Discord.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_Net_HttpException_Reason.md&amp;value=---%0Auid%3A%20Discord.Net.HttpException.Reason%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Net/HttpException.cs/#L32">View Source</a>
</span>
<a id="Discord_Net_HttpException_Reason_" data-uid="Discord.Net.HttpException.Reason*"></a>
<h4 id="Discord_Net_HttpException_Reason" data-uid="Discord.Net.HttpException.Reason">Reason</h4>
<div class="markdown level1 summary"><p>Gets the reason of the exception.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Reason { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.String</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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_Net_HttpException_Request.md&amp;value=---%0Auid%3A%20Discord.Net.HttpException.Request%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Net/HttpException.cs/#L36">View Source</a>
</span>
<a id="Discord_Net_HttpException_Request_" data-uid="Discord.Net.HttpException.Request*"></a>
<h4 id="Discord_Net_HttpException_Request" data-uid="Discord.Net.HttpException.Request">Request</h4>
<div class="markdown level1 summary"><p>Gets the request object used to send the request.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IRequest Request { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Net.IRequest.html">IRequest</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.Runtime.Serialization.ISerializable</span>
</div>
<div>
<span class="xref">System.Runtime.InteropServices._Exception</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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_Net_HttpException.md&amp;value=---%0Auid%3A%20Discord.Net.HttpException%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Net/HttpException.cs/#L9" 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