mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-25 14:06:41 +01:00
Deploy code docs to GitHub Pages for workflow run 3273
Commit: 074d1d0e4b
This commit is contained in:
tgstation-server-ci[bot]
@@ -3,7 +3,7 @@
|
||||
<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.5"/>
|
||||
<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/Extensions/ControllerBaseExtensions.cs Source File</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
@@ -30,7 +30,7 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.9.5 -->
|
||||
<!-- Generated by Doxygen 1.9.8 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
@@ -47,6 +47,11 @@ $(function() {
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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()"
|
||||
@@ -93,6 +98,7 @@ $(function() {
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_extensions.html">Tgstation.Server.Host.Extensions</a></div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>{</div>
|
||||
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html"> 20</a></span> <span class="keyword">static</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html">ControllerBaseExtensions</a></div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> {</div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html#a914f0cf95624da48a3b4b9c9a7e9b9a3"> 27</a></span> <span class="keyword">public</span> <span class="keyword">static</span> ObjectResult <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html#a914f0cf95624da48a3b4b9c9a7e9b9a3">Gone</a>(<span class="keyword">this</span> ControllerBase controller)</div>
|
||||
@@ -101,6 +107,7 @@ $(function() {
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html#a5dea5bfb8313dc112b60fc0936c5b658"> 37</a></span> <span class="keyword">public</span> <span class="keyword">static</span> ObjectResult <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html#a5dea5bfb8313dc112b60fc0936c5b658">StatusCode</a>(<span class="keyword">this</span> ControllerBase controller, HttpStatusCode statusCode, <span class="keywordtype">object</span>? errorMessage)</div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> => controller?.StatusCode((<span class="keywordtype">int</span>)statusCode, errorMessage) ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(controller));</div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
|
||||
<div class="foldopen" id="foldopen00048" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html#a5f8af101180efeb692684bc0eaa347c2"> 48</a></span> <span class="keyword">public</span> <span class="keyword">static</span> VirtualFileResult? <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html#a5f8af101180efeb692684bc0eaa347c2">TryServeFile</a>(<span class="keyword">this</span> ControllerBase controller, IWebHostEnvironment hostEnvironment, ILogger logger, <span class="keywordtype">string</span> path)</div>
|
||||
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> {</div>
|
||||
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> ArgumentNullException.ThrowIfNull(controller);</div>
|
||||
@@ -125,21 +132,23 @@ $(function() {
|
||||
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
|
||||
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">return</span> <span class="keyword">null</span>;</div>
|
||||
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>}</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_extensions_1_1_controller_base_extensions_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html">Tgstation.Server.Host.Extensions.ControllerBaseExtensions</a></div><div class="ttdoc">Extension methods for ControllerBase.</div><div class="ttdef"><b>Definition:</b> <a href="_controller_base_extensions_8cs_source.html#l00020">ControllerBaseExtensions.cs:21</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_extensions_1_1_controller_base_extensions_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html">Tgstation.Server.Host.Extensions.ControllerBaseExtensions</a></div><div class="ttdoc">Extension methods for ControllerBase.</div><div class="ttdef"><b>Definition</b> <a href="_controller_base_extensions_8cs_source.html#l00020">ControllerBaseExtensions.cs:21</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions_html_a5dea5bfb8313dc112b60fc0936c5b658"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html#a5dea5bfb8313dc112b60fc0936c5b658">Tgstation.Server.Host.Extensions.ControllerBaseExtensions.StatusCode</a></div><div class="ttdeci">static ObjectResult StatusCode(this ControllerBase controller, HttpStatusCode statusCode, object? errorMessage)</div><div class="ttdoc">Strongly type calls to ControllerBase.StatusCode(int, object).</div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions_html_a5f8af101180efeb692684bc0eaa347c2"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html#a5f8af101180efeb692684bc0eaa347c2">Tgstation.Server.Host.Extensions.ControllerBaseExtensions.TryServeFile</a></div><div class="ttdeci">static ? VirtualFileResult TryServeFile(this ControllerBase controller, IWebHostEnvironment hostEnvironment, ILogger logger, string path)</div><div class="ttdoc">Try to serve a given file path .</div><div class="ttdef"><b>Definition:</b> <a href="_controller_base_extensions_8cs_source.html#l00048">ControllerBaseExtensions.cs:48</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions_html_a5f8af101180efeb692684bc0eaa347c2"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html#a5f8af101180efeb692684bc0eaa347c2">Tgstation.Server.Host.Extensions.ControllerBaseExtensions.TryServeFile</a></div><div class="ttdeci">static ? VirtualFileResult TryServeFile(this ControllerBase controller, IWebHostEnvironment hostEnvironment, ILogger logger, string path)</div><div class="ttdoc">Try to serve a given file path .</div><div class="ttdef"><b>Definition</b> <a href="_controller_base_extensions_8cs_source.html#l00048">ControllerBaseExtensions.cs:48</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions_html_a914f0cf95624da48a3b4b9c9a7e9b9a3"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_controller_base_extensions.html#a914f0cf95624da48a3b4b9c9a7e9b9a3">Tgstation.Server.Host.Extensions.ControllerBaseExtensions.Gone</a></div><div class="ttdeci">static ObjectResult Gone(this ControllerBase controller)</div><div class="ttdoc">Generic 410 response.</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#l00003">AdministrationResponse.cs:4</a></div></div>
|
||||
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a></div><div class="ttdef"><b>Definition:</b> <a href="_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html#l00005">ChatChannel.cs:6</a></div></div>
|
||||
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html_a1a6adb59dd51244efabf4e548e7075c8"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a1a6adb59dd51244efabf4e548e7075c8">Tgstation.Server.Api.Models.ErrorCode</a></div><div class="ttdeci">ErrorCode</div><div class="ttdoc">Types of Response.ErrorMessageResponses that the API may return.</div><div class="ttdef"><b>Definition:</b> <a href="_error_code_8cs_source.html#l00011">ErrorCode.cs:12</a></div></div>
|
||||
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_extensions_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_extensions.html">Tgstation.Server.Host.Extensions</a></div><div class="ttdef"><b>Definition:</b> <a href="_application_builder_extensions_8cs_source.html#l00020">ApplicationBuilderExtensions.cs:21</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#l00003">AdministrationResponse.cs:4</a></div></div>
|
||||
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a></div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html#l00005">ChatChannel.cs:6</a></div></div>
|
||||
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html_a1a6adb59dd51244efabf4e548e7075c8"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a1a6adb59dd51244efabf4e548e7075c8">Tgstation.Server.Api.Models.ErrorCode</a></div><div class="ttdeci">ErrorCode</div><div class="ttdoc">Types of Response.ErrorMessageResponses that the API may return.</div><div class="ttdef"><b>Definition</b> <a href="_error_code_8cs_source.html#l00011">ErrorCode.cs:12</a></div></div>
|
||||
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_extensions_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_extensions.html">Tgstation.Server.Host.Extensions</a></div><div class="ttdef"><b>Definition</b> <a href="_application_builder_extensions_8cs_source.html#l00020">ApplicationBuilderExtensions.cs:21</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
|
||||
Generated by <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
Block a user