cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-24 21:46:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tgstation-server/_authority_response_8cs_source.html
T

134 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tgstation-server: src/Tgstation.Server.Host/Authority/Core/AuthorityResponse.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.19.3</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_7b5e30ed08996bf1ab2c41e458010f21.html">Authority</a></li><li class="navelem"><a class="el" href="dir_ac26146c90963479fc2fc32a1e6e42a1.html">Core</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">AuthorityResponse.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_authority_response_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">using </span>System;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Diagnostics.CodeAnalysis;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response.html">Tgstation.Server.Api.Models.Response</a>;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core.html">Tgstation.Server.Host.Authority.Core</a></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span>{</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">public</span> <span class="keyword">class </span><a class="code hl_class" href="class_authority_response.html">AuthorityResponse</a></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> [MemberNotNullWhen(<span class="keyword">false</span>, nameof(<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a4f8c0484db02cf5f5d88d84893e0edb4">ErrorMessage</a>))]</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> [MemberNotNullWhen(<span class="keyword">false</span>, nameof(<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a57c3d919bef955573b0c863f6f93c7ee">FailureResponse</a>))]</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a324716e9639d2539cf484a8c4e767600"> 18</a></span> <span class="keyword">public</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a324716e9639d2539cf484a8c4e767600">Success</a> =&gt; <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a4f8c0484db02cf5f5d88d84893e0edb4">ErrorMessage</a> == <span class="keyword">null</span>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a4f8c0484db02cf5f5d88d84893e0edb4"> 23</a></span> <span class="keyword">public</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html">ErrorMessageResponse</a>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a4f8c0484db02cf5f5d88d84893e0edb4">ErrorMessage</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a57c3d919bef955573b0c863f6f93c7ee"> 28</a></span> <span class="keyword">public</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core.html#a0014d9d38ddef55b17fc52f0e4bd071c">HttpFailureResponse</a>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a57c3d919bef955573b0c863f6f93c7ee">FailureResponse</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="}">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#af2cf630e1b565f5842f90dd689a2d096"> 33</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#af2cf630e1b565f5842f90dd689a2d096">AuthorityResponse</a>()</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> }</div>
</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="foldopen" id="foldopen00042" data-start="{" data-end="}">
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#ab7e3b072644d1f53f06e3a80b804fac3"> 42</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#ab7e3b072644d1f53f06e3a80b804fac3">AuthorityResponse</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html">ErrorMessageResponse</a> errorMessage, <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core.html#a0014d9d38ddef55b17fc52f0e4bd071c">HttpFailureResponse</a> failureResponse)</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a4f8c0484db02cf5f5d88d84893e0edb4">ErrorMessage</a> = errorMessage ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(errorMessage));</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a57c3d919bef955573b0c863f6f93c7ee">FailureResponse</a> = failureResponse;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> }</div>
</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> }</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>}</div>
<div class="ttc" id="aclass_authority_response_html"><div class="ttname"><a href="class_authority_response.html">AuthorityResponse</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html">Tgstation.Server.Api.Models.Response.ErrorMessageResponse</a></div><div class="ttdoc">Represents an error message returned by the server.</div><div class="ttdef"><b>Definition</b> <a href="_error_message_response_8cs_source.html#l00011">ErrorMessageResponse.cs:12</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response_html_a324716e9639d2539cf484a8c4e767600"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a324716e9639d2539cf484a8c4e767600">Tgstation.Server.Host.Authority.Core.AuthorityResponse.Success</a></div><div class="ttdeci">virtual bool Success</div><div class="ttdoc">Checks if the AuthorityResponse was successful.</div><div class="ttdef"><b>Definition</b> <a href="_authority_response_8cs_source.html#l00018">AuthorityResponse.cs:18</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response_html_a4f8c0484db02cf5f5d88d84893e0edb4"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a4f8c0484db02cf5f5d88d84893e0edb4">Tgstation.Server.Host.Authority.Core.AuthorityResponse.ErrorMessage</a></div><div class="ttdeci">ErrorMessageResponse? ErrorMessage</div><div class="ttdoc">Gets the associated ErrorMessageResponse. Must only be used if Success is false.</div><div class="ttdef"><b>Definition</b> <a href="_authority_response_8cs_source.html#l00023">AuthorityResponse.cs:23</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response_html_a57c3d919bef955573b0c863f6f93c7ee"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#a57c3d919bef955573b0c863f6f93c7ee">Tgstation.Server.Host.Authority.Core.AuthorityResponse.FailureResponse</a></div><div class="ttdeci">HttpFailureResponse? FailureResponse</div><div class="ttdoc">The HttpFailureResponse.</div><div class="ttdef"><b>Definition</b> <a href="_authority_response_8cs_source.html#l00028">AuthorityResponse.cs:28</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response_html_ab7e3b072644d1f53f06e3a80b804fac3"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#ab7e3b072644d1f53f06e3a80b804fac3">Tgstation.Server.Host.Authority.Core.AuthorityResponse.AuthorityResponse</a></div><div class="ttdeci">AuthorityResponse(ErrorMessageResponse errorMessage, HttpFailureResponse failureResponse)</div><div class="ttdoc">Initializes a new instance of the AuthorityResponse class.</div><div class="ttdef"><b>Definition</b> <a href="_authority_response_8cs_source.html#l00042">AuthorityResponse.cs:42</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response_html_af2cf630e1b565f5842f90dd689a2d096"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_authority_response.html#af2cf630e1b565f5842f90dd689a2d096">Tgstation.Server.Host.Authority.Core.AuthorityResponse.AuthorityResponse</a></div><div class="ttdeci">AuthorityResponse()</div><div class="ttdoc">Initializes a new instance of the AuthorityResponse class.</div><div class="ttdef"><b>Definition</b> <a href="_authority_response_8cs_source.html#l00033">AuthorityResponse.cs:33</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response.html">Tgstation.Server.Api.Models.Response</a></div><div class="ttdef"><b>Definition</b> <a href="_administration_response_8cs_source.html#l00005">AdministrationResponse.cs:6</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core.html">Tgstation.Server.Host.Authority.Core</a></div><div class="ttdef"><b>Definition</b> <a href="_authority_base_8cs_source.html#l00013">AuthorityBase.cs:14</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_html_a0014d9d38ddef55b17fc52f0e4bd071c"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core.html#a0014d9d38ddef55b17fc52f0e4bd071c">Tgstation.Server.Host.Authority.Core.HttpFailureResponse</a></div><div class="ttdeci">HttpFailureResponse</div><div class="ttdoc">Indicates the type of HTTP status code an failing AuthorityResponse should generate.</div><div class="ttdef"><b>Definition</b> <a href="_http_failure_response_8cs_source.html#l00006">HttpFailureResponse.cs:7</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink