mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-25 05:56:58 +01:00
123 lines
14 KiB
HTML
123 lines
14 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.Host/Authority/IAdministrationAuthority.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"> 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&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&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&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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">IAdministrationAuthority.cs</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_i_administration_authority_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.Threading;</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><span class="keyword">using </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="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_authority.html">Tgstation.Server.Host.Authority</a></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>{</div>
|
|
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html"> 12</a></span> <span class="keyword">public</span> <span class="keyword">interface </span><a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html">IAdministrationAuthority</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_i_authority.html">IAuthority</a></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> {</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#a6a78ea6b81446410b20da3686f7af751"> 20</a></span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_requirements_gated.html">RequirementsGated<AuthorityResponse<AdministrationResponse></a>> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#a6a78ea6b81446410b20da3686f7af751">GetUpdateInformation</a>(<span class="keywordtype">bool</span> forceFresh, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#a2c966d60fd294a5f2ec1281e2bfd1bdb"> 29</a></span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_requirements_gated.html">RequirementsGated<AuthorityResponse<ServerUpdateResponse></a>> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#a2c966d60fd294a5f2ec1281e2bfd1bdb">TriggerServerVersionChange</a>(Version targetVersion, <span class="keywordtype">bool</span> uploadZip, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#ab4c8bc298f6a25e0d2294b2e2b87840d"> 35</a></span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_requirements_gated.html">RequirementsGated<AuthorityResponse></a> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#ab4c8bc298f6a25e0d2294b2e2b87840d">TriggerServerRestart</a>();</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#ae423770191b18e1b5a47bc434b8ac177"> 43</a></span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_requirements_gated.html">RequirementsGated<AuthorityResponse<LogFileResponse></a>> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#ae423770191b18e1b5a47bc434b8ac177">GetLog</a>(<span class="keywordtype">string</span> path, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>}</div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_requirements_gated_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_requirements_gated.html">Tgstation.Server.Host.Authority.Core.RequirementsGated</a></div><div class="ttdoc">Evaluates a set of IAuthorizationRequirements to be checked before executing a response.</div><div class="ttdef"><b>Definition</b> <a href="_requirements_gated_02_t_result_03_8cs_source.html#l00016">RequirementsGated{TResult}.cs:17</a></div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_i_authority_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_i_authority.html">Tgstation.Server.Host.Authority.Core.IAuthority</a></div><div class="ttdoc">Business logic for interating with the server.</div><div class="ttdef"><b>Definition</b> <a href="_i_authority_8cs_source.html#l00008">IAuthority.cs:9</a></div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html">Tgstation.Server.Host.Authority.IAdministrationAuthority</a></div><div class="ttdoc">IAuthority for administrative server operations.</div><div class="ttdef"><b>Definition</b> <a href="_i_administration_authority_8cs_source.html#l00012">IAdministrationAuthority.cs:13</a></div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority_html_a2c966d60fd294a5f2ec1281e2bfd1bdb"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#a2c966d60fd294a5f2ec1281e2bfd1bdb">Tgstation.Server.Host.Authority.IAdministrationAuthority.TriggerServerVersionChange</a></div><div class="ttdeci">RequirementsGated< AuthorityResponse< ServerUpdateResponse > > TriggerServerVersionChange(Version targetVersion, bool uploadZip, CancellationToken cancellationToken)</div><div class="ttdoc">Triggers a restart of tgstation-server without terminating running game instances,...</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority_html_a6a78ea6b81446410b20da3686f7af751"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#a6a78ea6b81446410b20da3686f7af751">Tgstation.Server.Host.Authority.IAdministrationAuthority.GetUpdateInformation</a></div><div class="ttdeci">RequirementsGated< AuthorityResponse< AdministrationResponse > > GetUpdateInformation(bool forceFresh, CancellationToken cancellationToken)</div><div class="ttdoc">Gets the AdministrationResponse containing server update information.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority_html_ab4c8bc298f6a25e0d2294b2e2b87840d"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#ab4c8bc298f6a25e0d2294b2e2b87840d">Tgstation.Server.Host.Authority.IAdministrationAuthority.TriggerServerRestart</a></div><div class="ttdeci">RequirementsGated< AuthorityResponse > TriggerServerRestart()</div><div class="ttdoc">Triggers a restart of tgstation-server without terminating running game instances.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority_html_ae423770191b18e1b5a47bc434b8ac177"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_administration_authority.html#ae423770191b18e1b5a47bc434b8ac177">Tgstation.Server.Host.Authority.IAdministrationAuthority.GetLog</a></div><div class="ttdeci">RequirementsGated< AuthorityResponse< LogFileResponse > > GetLog(string path, CancellationToken cancellationToken)</div><div class="ttdoc">Get a ticket for downloading a log file at a given path .</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_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_authority.html">Tgstation.Server.Host.Authority</a></div><div class="ttdef"><b>Definition</b> <a href="_administration_authority_8cs_source.html#l00025">AdministrationAuthority.cs:26</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.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|