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/_i_administration_client_8cs_source.html
T

131 lines
15 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.Client/IAdministrationClient.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_9826fb2d31585a830723e6d7089b5d0e.html">Tgstation.Server.Client</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">IAdministrationClient.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_administration_client_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><span class="keyword">using </span>System.IO;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>System.Threading;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>System.Threading.Tasks;</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">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_request.html">Tgstation.Server.Api.Models.Request</a>;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</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="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_client.html">Tgstation.Server.Client</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="foldopen" id="foldopen00015" data-start="{" data-end="};">
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html"> 15</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_client_1_1_i_administration_client.html">IAdministrationClient</a></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a01ee85075dae122776a1210de923c865"> 23</a></span> ValueTask&lt;AdministrationResponse&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a01ee85075dae122776a1210de923c865">Read</a>(<span class="keywordtype">bool</span> forceFresh = <span class="keyword">false</span>, CancellationToken cancellationToken = <span class="keywordflow">default</span>);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a0e8be89151e5fa793d617ec0ba358f75"> 32</a></span> ValueTask&lt;ServerUpdateResponse&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a0e8be89151e5fa793d617ec0ba358f75">Update</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_server_update_request.html">ServerUpdateRequest</a> updateRequest, <a class="code hl_class" href="class_stream.html">Stream</a>? zipFileStream, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a05ecd50b6964e29e3f711719d3b9e3df"> 39</a></span> ValueTask <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a05ecd50b6964e29e3f711719d3b9e3df">Restart</a>(CancellationToken cancellationToken);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#ae5dbf8b6160cc0dd093225310bfd9986"> 47</a></span> ValueTask&lt;List&lt;LogFileResponse&gt;&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#ae5dbf8b6160cc0dd093225310bfd9986">ListLogs</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_pagination_settings.html">PaginationSettings</a>? paginationSettings, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a6b249538c980709b666f28d28f0b03d0"> 55</a></span> ValueTask&lt;Tuple&lt;LogFileResponse, Stream&gt;&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a6b249538c980709b666f28d28f0b03d0">GetLog</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_log_file_response.html">LogFileResponse</a> logFile, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> }</div>
</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>}</div>
<div class="ttc" id="aclass_stream_html"><div class="ttname"><a href="class_stream.html">Stream</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_server_update_request_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_server_update_request.html">Tgstation.Server.Api.Models.Request.ServerUpdateRequest</a></div><div class="ttdoc">Represents a request to update TGS.</div><div class="ttdef"><b>Definition</b> <a href="_server_update_request_8cs_source.html#l00008">ServerUpdateRequest.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_log_file_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_log_file_response.html">Tgstation.Server.Api.Models.Response.LogFileResponse</a></div><div class="ttdoc">Represents a server log file.</div><div class="ttdef"><b>Definition</b> <a href="_log_file_response_8cs_source.html#l00008">LogFileResponse.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_pagination_settings_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_pagination_settings.html">Tgstation.Server.Client.PaginationSettings</a></div><div class="ttdoc">Settings for a paginated request.</div><div class="ttdef"><b>Definition</b> <a href="_pagination_settings_8cs_source.html#l00006">PaginationSettings.cs:7</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_administration_client_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html">Tgstation.Server.Client.IAdministrationClient</a></div><div class="ttdoc">For managing server administration.</div><div class="ttdef"><b>Definition</b> <a href="_i_administration_client_8cs_source.html#l00015">IAdministrationClient.cs:16</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_administration_client_html_a01ee85075dae122776a1210de923c865"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a01ee85075dae122776a1210de923c865">Tgstation.Server.Client.IAdministrationClient.Read</a></div><div class="ttdeci">ValueTask&lt; AdministrationResponse &gt; Read(bool forceFresh=false, CancellationToken cancellationToken=default)</div><div class="ttdoc">Get the AdministrationResponse represented by the IAdministrationClient.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_administration_client_html_a05ecd50b6964e29e3f711719d3b9e3df"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a05ecd50b6964e29e3f711719d3b9e3df">Tgstation.Server.Client.IAdministrationClient.Restart</a></div><div class="ttdeci">ValueTask Restart(CancellationToken cancellationToken)</div><div class="ttdoc">Restarts the TGS server.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_administration_client_html_a0e8be89151e5fa793d617ec0ba358f75"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a0e8be89151e5fa793d617ec0ba358f75">Tgstation.Server.Client.IAdministrationClient.Update</a></div><div class="ttdeci">ValueTask&lt; ServerUpdateResponse &gt; Update(ServerUpdateRequest updateRequest, Stream? zipFileStream, CancellationToken cancellationToken)</div><div class="ttdoc">Updates the AdministrationResponse setttings.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_administration_client_html_a6b249538c980709b666f28d28f0b03d0"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#a6b249538c980709b666f28d28f0b03d0">Tgstation.Server.Client.IAdministrationClient.GetLog</a></div><div class="ttdeci">ValueTask&lt; Tuple&lt; LogFileResponse, Stream &gt; &gt; GetLog(LogFileResponse logFile, CancellationToken cancellationToken)</div><div class="ttdoc">Download a given logFile .</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_administration_client_html_ae5dbf8b6160cc0dd093225310bfd9986"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html#ae5dbf8b6160cc0dd093225310bfd9986">Tgstation.Server.Client.IAdministrationClient.ListLogs</a></div><div class="ttdeci">ValueTask&lt; List&lt; LogFileResponse &gt; &gt; ListLogs(PaginationSettings? paginationSettings, CancellationToken cancellationToken)</div><div class="ttdoc">Lists the log files available for download.</div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_request.html">Tgstation.Server.Api.Models.Request</a></div><div class="ttdef"><b>Definition</b> <a href="_chat_bot_create_request_8cs_source.html#l00003">ChatBotCreateRequest.cs:4</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_client_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_client.html">Tgstation.Server.Client</a></div><div class="ttdef"><b>Definition</b> <a href="_authenticated_graph_q_l_server_client_8cs_source.html#l00011">AuthenticatedGraphQLServerClient.cs:12</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