Files
tgstation-server/_server_information_response_8cs_source.html

132 lines
19 KiB
HTML

<!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.Api/Models/Response/ServerInformationResponse.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_2ea2465064f3ff030c6dd6700a328d91.html">Tgstation.Server.Api</a></li><li class="navelem"><a class="el" href="dir_61d7974a657c30011f457b376d274ee7.html">Models</a></li><li class="navelem"><a class="el" href="dir_9a3705f7aea0208228be3f6f90533d3c.html">Response</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">ServerInformationResponse.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_server_information_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.Collections.Generic;</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">namespace </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="foldopen" id="foldopen00009" data-start="{" data-end="};">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html"> 9</a></span> <span class="keyword">public</span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html">ServerInformationResponse</a> : Internal.ServerInformationBase</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#ab6d9319159ca7ffeca0f1605dec19911"> 15</a></span> <span class="keyword">public</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#ab6d9319159ca7ffeca0f1605dec19911">Version</a>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#ab6d9319159ca7ffeca0f1605dec19911">Version</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a1475d6ba2418f895aa8376d4268e9056"> 21</a></span> <span class="keyword">public</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#ab6d9319159ca7ffeca0f1605dec19911">Version</a>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a1475d6ba2418f895aa8376d4268e9056">ApiVersion</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</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_api_1_1_models_1_1_response_1_1_server_information_response.html#a7e7ab24625a8d0f58b19da0919e735b3"> 27</a></span> <span class="keyword">public</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#ab6d9319159ca7ffeca0f1605dec19911">Version</a>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a7e7ab24625a8d0f58b19da0919e735b3">DMApiVersion</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a0343863ebc1daa94fd42a55d2715e255"> 32</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a0343863ebc1daa94fd42a55d2715e255">WindowsHost</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#acdc8a6970be4a43efcc327f498eb9524"> 37</a></span> <span class="keyword">public</span> Dictionary&lt;OAuthProvider, OAuthProviderInfo&gt;? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#acdc8a6970be4a43efcc327f498eb9524">OAuthProviderInfos</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#acfb44000560d0c4a52ed862ef6b3b001"> 42</a></span> <span class="keyword">public</span> List&lt;OidcProviderInfo&gt;? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#acfb44000560d0c4a52ed862ef6b3b001">OidcProviderInfos</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a58d9ff8b2fca38ce99282358614a4ca5"> 47</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a58d9ff8b2fca38ce99282358614a4ca5">OidcStrictMode</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#af4a84942df0ec4f5433021e32c470de1"> 53</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#af4a84942df0ec4f5433021e32c470de1">UpdateInProgress</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> [ResponseOptions]</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a7fab0429cdf0d3efab2173e189e71017"> 59</a></span> <span class="keyword">public</span> ICollection&lt;SwarmServerResponse&gt;? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a7fab0429cdf0d3efab2173e189e71017">SwarmServers</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> }</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html">Tgstation.Server.Api.Models.Response.ServerInformationResponse</a></div><div class="ttdoc">Represents basic server information.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00009">ServerInformationResponse.cs:10</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response_html_a0343863ebc1daa94fd42a55d2715e255"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a0343863ebc1daa94fd42a55d2715e255">Tgstation.Server.Api.Models.Response.ServerInformationResponse.WindowsHost</a></div><div class="ttdeci">bool WindowsHost</div><div class="ttdoc">If the server is running on a windows operating system.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00032">ServerInformationResponse.cs:32</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response_html_a1475d6ba2418f895aa8376d4268e9056"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a1475d6ba2418f895aa8376d4268e9056">Tgstation.Server.Api.Models.Response.ServerInformationResponse.ApiVersion</a></div><div class="ttdeci">Version? ApiVersion</div><div class="ttdoc">The Api version of the host.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00021">ServerInformationResponse.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_server_information_response_html_a58d9ff8b2fca38ce99282358614a4ca5"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a58d9ff8b2fca38ce99282358614a4ca5">Tgstation.Server.Api.Models.Response.ServerInformationResponse.OidcStrictMode</a></div><div class="ttdeci">bool OidcStrictMode</div><div class="ttdoc">If only OIDC logins and registration is allowed.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00047">ServerInformationResponse.cs:47</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response_html_a7e7ab24625a8d0f58b19da0919e735b3"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a7e7ab24625a8d0f58b19da0919e735b3">Tgstation.Server.Api.Models.Response.ServerInformationResponse.DMApiVersion</a></div><div class="ttdeci">Version? DMApiVersion</div><div class="ttdoc">The DMAPI interop version the server uses.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00027">ServerInformationResponse.cs:27</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response_html_a7fab0429cdf0d3efab2173e189e71017"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#a7fab0429cdf0d3efab2173e189e71017">Tgstation.Server.Api.Models.Response.ServerInformationResponse.SwarmServers</a></div><div class="ttdeci">ICollection&lt; SwarmServerResponse &gt;? SwarmServers</div><div class="ttdoc">A ICollection&lt;T&gt; of connected SwarmServerResponses.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00059">ServerInformationResponse.cs:59</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response_html_ab6d9319159ca7ffeca0f1605dec19911"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#ab6d9319159ca7ffeca0f1605dec19911">Tgstation.Server.Api.Models.Response.ServerInformationResponse.Version</a></div><div class="ttdeci">Version? Version</div><div class="ttdoc">The version of the host.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00015">ServerInformationResponse.cs:15</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response_html_acdc8a6970be4a43efcc327f498eb9524"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#acdc8a6970be4a43efcc327f498eb9524">Tgstation.Server.Api.Models.Response.ServerInformationResponse.OAuthProviderInfos</a></div><div class="ttdeci">Dictionary&lt; OAuthProvider, OAuthProviderInfo &gt;? OAuthProviderInfos</div><div class="ttdoc">Map of OAuthProvider to the OAuthProviderInfo for them.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00037">ServerInformationResponse.cs:37</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response_html_acfb44000560d0c4a52ed862ef6b3b001"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#acfb44000560d0c4a52ed862ef6b3b001">Tgstation.Server.Api.Models.Response.ServerInformationResponse.OidcProviderInfos</a></div><div class="ttdeci">List&lt; OidcProviderInfo &gt;? OidcProviderInfos</div><div class="ttdoc">List of configured OidcProviderInfos.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00042">ServerInformationResponse.cs:42</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response_html_af4a84942df0ec4f5433021e32c470de1"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html#af4a84942df0ec4f5433021e32c470de1">Tgstation.Server.Api.Models.Response.ServerInformationResponse.UpdateInProgress</a></div><div class="ttdeci">bool UpdateInProgress</div><div class="ttdoc">If there is a server update in progress.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00053">ServerInformationResponse.cs:53</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><!-- 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>