Deploy code docs to GitHub Pages for workflow run 1264

Commit: db95788964
This commit is contained in:
tgstation-server
2022-12-20 18:34:55 +00:00
parent e755a192a5
commit 5f1e415cfe
8997 changed files with 88730 additions and 71206 deletions
+17 -10
View File
@@ -1,9 +1,9 @@
<!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">
<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.4"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tgstation-server: src/Tgstation.Server.Host/Controllers/InstanceRequiredController.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -31,10 +31,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
@@ -57,9 +57,16 @@ $(function() {
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<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">
@@ -174,9 +181,9 @@ $(function() {
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html_a8b5ef7433a5d9f43de5a927211c56d15"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a8b5ef7433a5d9f43de5a927211c56d15">Tgstation.Server.Host.Controllers.InstanceRequiredController.InstanceRequiredController</a></div><div class="ttdeci">InstanceRequiredController(IInstanceManager instanceManager, IDatabaseContext databaseContext, IAuthenticationContextFactory authenticationContextFactory, ILogger&lt; InstanceRequiredController &gt; logger)</div><div class="ttdoc">Initializes a new instance of the InstanceRequiredController class.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00068">InstanceRequiredController.cs:68</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html_a9aa5378db351ad07ac7b3706ac7c6620"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a9aa5378db351ad07ac7b3706ac7c6620">Tgstation.Server.Host.Controllers.InstanceRequiredController.WithComponentInstance</a></div><div class="ttdeci">async Task&lt; IActionResult &gt; WithComponentInstance(Func&lt; IInstanceCore, Task&lt; IActionResult &gt; &gt; action)</div><div class="ttdoc">Run a given action with the relevant IInstance.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00105">InstanceRequiredController.cs:105</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html_a9f979bc0f31b5c897c27b79515ea44f5"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a9f979bc0f31b5c897c27b79515ea44f5">Tgstation.Server.Host.Controllers.InstanceRequiredController.ValidateInstanceOnlineStatus</a></div><div class="ttdeci">static bool ValidateInstanceOnlineStatus(IInstanceManager instanceManager, ILogger logger, Api.Models.Instance metadata)</div><div class="ttdoc">Corrects discrepencies between the Api.Models.Instance.Online status of IInstances in the database vs...</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00034">InstanceRequiredController.cs:34</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html_af5b97c9bb64fc4bd3d590c8fcd2ace8c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#af5b97c9bb64fc4bd3d590c8fcd2ace8c">Tgstation.Server.Host.Controllers.InstanceRequiredController.ValidateRequest</a></div><div class="ttdeci">override async Task&lt; IActionResult &gt; ValidateRequest(CancellationToken cancellationToken)</div><div class="ttdoc">Performs validation a request.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00083">InstanceRequiredController.cs:83</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html_af5b97c9bb64fc4bd3d590c8fcd2ace8c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#af5b97c9bb64fc4bd3d590c8fcd2ace8c">Tgstation.Server.Host.Controllers.InstanceRequiredController.ValidateRequest</a></div><div class="ttdeci">override async Task&lt; IActionResult &gt; ValidateRequest(CancellationToken cancellationToken)</div><div class="ttdoc">Performs validation a request. A Task&lt;TResult&gt; resulting in an appropriate IActionResult on validatio...</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00083">InstanceRequiredController.cs:83</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context.html">Tgstation.Server.Host.Database.DatabaseContext</a></div><div class="ttdoc">Backend abstract implementation of IDatabaseContext.</div><div class="ttdef"><b>Definition:</b> <a href="_database_context_8cs_source.html#l00024">DatabaseContext.cs:25</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_html_ac2e88d53bf1b6ac87d175d83ed39da7c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context.html#ac2e88d53bf1b6ac87d175d83ed39da7c">Tgstation.Server.Host.Database.DatabaseContext.Save</a></div><div class="ttdeci">Task Save(CancellationToken cancellationToken)</div><div class="ttdoc">Saves changes made to the IDatabaseContext.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_html_ac2e88d53bf1b6ac87d175d83ed39da7c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context.html#ac2e88d53bf1b6ac87d175d83ed39da7c">Tgstation.Server.Host.Database.DatabaseContext.Save</a></div><div class="ttdeci">Task Save(CancellationToken cancellationToken)</div><div class="ttdoc">Saves changes made to the IDatabaseContext. A Task representing the running operation.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context.html">Tgstation.Server.Host.Security.AuthenticationContext</a></div><div class="ttdef"><b>Definition:</b> <a href="_authentication_context_8cs_source.html#l00010">AuthenticationContext.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context_html_ae1ac6fad423d67f5332c2cf64f4df926"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context.html#ae1ac6fad423d67f5332c2cf64f4df926">Tgstation.Server.Host.Security.AuthenticationContext.InstancePermissionSet</a></div><div class="ttdeci">InstancePermissionSet InstancePermissionSet</div><div class="ttdoc">The User's effective Models.InstancePermissionSet if applicable.</div><div class="ttdef"><b>Definition:</b> <a href="_authentication_context_8cs_source.html#l00019">AuthenticationContext.cs:19</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_instance_core_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_instance_core.html">Tgstation.Server.Host.Components.IInstanceCore</a></div><div class="ttdoc">For interacting with the instance services.</div><div class="ttdef"><b>Definition:</b> <a href="_i_instance_core_8cs_source.html#l00015">IInstanceCore.cs:16</a></div></div>
@@ -194,7 +201,7 @@ $(function() {
</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.4
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.5
</small></address>
</body>
</html>