cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-25 05:56:58 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tgstation-server/_administration_client_8cs_source.html
T

201 lines
34 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/AdministrationClient.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">AdministrationClient.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_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><span class="keyword">using </span>System.Web;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </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.html">Tgstation.Server.Api</a>;</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</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="l00010" name="l00010"></a><span class="lineno"> 10</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="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</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="l00013" name="l00013"></a><span class="lineno"> 13</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="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html"> 15</a></span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html">AdministrationClient</a> : <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_paginated_client.html">PaginatedClient</a>, <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="foldopen" id="foldopen00021" data-start="{" data-end="}">
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#aa5d48433766cd2f29ee60007767f5387"> 21</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#aa5d48433766cd2f29ee60007767f5387">AdministrationClient</a>(<a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html">IApiClient</a> apiClient)</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> : base(apiClient)</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> }</div>
</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</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_client_1_1_administration_client.html#a9ec9efd0a58b3ceb62dc114c097a6eb9"> 27</a></span> <span class="keyword">public</span> ValueTask&lt;AdministrationResponse&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a9ec9efd0a58b3ceb62dc114c097a6eb9">Read</a>(<span class="keywordtype">bool</span> forceFresh, CancellationToken cancellationToken) =&gt; <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.Read&lt;<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_administration_response.html">AdministrationResponse</a>&gt;($<span class="stringliteral">&quot;{Routes.Administration}?fresh={forceFresh}&quot;</span>, cancellationToken);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="foldopen" id="foldopen00030" data-start="{" data-end="}">
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a6a88406ff2dd9da8c10973db48f54070"> 30</a></span> <span class="keyword">public</span> async ValueTask&lt;ServerUpdateResponse&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a6a88406ff2dd9da8c10973db48f54070">Update</a>(</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <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,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_class" href="class_stream.html">Stream</a>? zipFileStream,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> CancellationToken cancellationToken)</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">if</span> (updateRequest == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(updateRequest));</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">if</span> (updateRequest.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_server_update_request.html#aa4d989b24c927c907ae45578829a2071">UploadZip</a> == <span class="keyword">true</span> &amp;&amp; zipFileStream == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(zipFileStream));</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> var result = await <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.Update&lt;<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>, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_update_response.html">ServerUpdateResponse</a>&gt;(</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a1bd414117e790a954bd7bfb83c7d4fc9">Administration</a>,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> updateRequest,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> cancellationToken);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">if</span> (updateRequest.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_server_update_request.html#aa4d989b24c927c907ae45578829a2071">UploadZip</a> == <span class="keyword">true</span>)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> await <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html#a2962556fb0b3a82c83593d23d70ace2a">Upload</a>(result, zipFileStream, cancellationToken).ConfigureAwait(<span class="keyword">false</span>);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">return</span> result;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> }</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</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_client_1_1_administration_client.html#afd86486b34f0abb341fba11503edce77"> 53</a></span> <span class="keyword">public</span> ValueTask <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#afd86486b34f0abb341fba11503edce77">Restart</a>(CancellationToken cancellationToken) =&gt; <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html#a3db5ef824b0f9492d416bc1fdd8b1984">Delete</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a1bd414117e790a954bd7bfb83c7d4fc9">Administration</a>, cancellationToken);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a5f279845f5b5a8dcd837bbf99ff06b9b"> 56</a></span> <span class="keyword">public</span> ValueTask&lt;List&lt;LogFileResponse&gt;&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a5f279845f5b5a8dcd837bbf99ff06b9b">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="l00057" name="l00057"></a><span class="lineno"> 57</span> =&gt; ReadPaged&lt;LogFileResponse&gt;(paginationSettings, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#aeb032cc314264cd0214895fe0c6b7670">Logs</a>, <span class="keyword">null</span>, cancellationToken);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="foldopen" id="foldopen00060" data-start="{" data-end="}">
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a3a5d6656c8ffc30db1d0d115b2a34c00"> 60</a></span> <span class="keyword">public</span> async ValueTask&lt;Tuple&lt;LogFileResponse, Stream&gt;&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a3a5d6656c8ffc30db1d0d115b2a34c00">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="l00061" name="l00061"></a><span class="lineno"> 61</span> {</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> var resultFile = await <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.Read&lt;<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>&gt;(</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> Routes.Logs + <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a427423a8a36ba74df914acb74ffb0483">SanitizeGetPath</a>(</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> HttpUtility.UrlEncode(</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> logFile?.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_log_file_response.html#aaa23f6083d7eaa3fee7d3c88f4d7325a">Name</a> ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(logFile)))),</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> cancellationToken)</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> .ConfigureAwait(<span class="keyword">false</span>);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> var stream = await <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html#a0a6186386ebd4d1ef1c9cec46a381d9a">Download</a>(resultFile, cancellationToken).ConfigureAwait(<span class="keyword">false</span>);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">try</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> {</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordflow">return</span> Tuple.Create(resultFile, stream);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> }</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">catch</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> {</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> stream.Dispose();</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordflow">throw</span>;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> }</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> }</div>
</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</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_request_1_1_server_update_request_html_aa4d989b24c927c907ae45578829a2071"><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#aa4d989b24c927c907ae45578829a2071">Tgstation.Server.Api.Models.Request.ServerUpdateRequest.UploadZip</a></div><div class="ttdeci">bool? UploadZip</div><div class="ttdoc">If the user will provide the server update package .zip file via file transfer as opposed to TGS retr...</div><div class="ttdef"><b>Definition</b> <a href="_server_update_request_8cs_source.html#l00020">ServerUpdateRequest.cs:20</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_administration_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_administration_response.html">Tgstation.Server.Api.Models.Response.AdministrationResponse</a></div><div class="ttdoc">Represents administrative server information.</div><div class="ttdef"><b>Definition</b> <a href="_administration_response_8cs_source.html#l00010">AdministrationResponse.cs:11</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_api_1_1_models_1_1_response_1_1_log_file_response_html_aaa23f6083d7eaa3fee7d3c88f4d7325a"><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#aaa23f6083d7eaa3fee7d3c88f4d7325a">Tgstation.Server.Api.Models.Response.LogFileResponse.Name</a></div><div class="ttdeci">string? Name</div><div class="ttdoc">The name of the log file.</div><div class="ttdef"><b>Definition</b> <a href="_log_file_response_8cs_source.html#l00014">LogFileResponse.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_update_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_update_response.html">Tgstation.Server.Api.Models.Response.ServerUpdateResponse</a></div><div class="ttdoc">A response to a Request.ServerUpdateRequest.</div><div class="ttdef"><b>Definition</b> <a href="_server_update_response_8cs_source.html#l00010">ServerUpdateResponse.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_routes_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Tgstation.Server.Api.Routes</a></div><div class="ttdoc">Routes to a server actions.</div><div class="ttdef"><b>Definition</b> <a href="_routes_8cs_source.html#l00008">Routes.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_routes_html_a1bd414117e790a954bd7bfb83c7d4fc9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a1bd414117e790a954bd7bfb83c7d4fc9">Tgstation.Server.Api.Routes.Administration</a></div><div class="ttdeci">const string Administration</div><div class="ttdoc">The server administration controller.</div><div class="ttdef"><b>Definition</b> <a href="_routes_8cs_source.html#l00028">Routes.cs:28</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_routes_html_a427423a8a36ba74df914acb74ffb0483"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a427423a8a36ba74df914acb74ffb0483">Tgstation.Server.Api.Routes.SanitizeGetPath</a></div><div class="ttdeci">static string SanitizeGetPath(string path)</div><div class="ttdoc">Sanitize a Models.Response.FileTicketResponse path for use in a GET Uri.</div><div class="ttdef"><b>Definition</b> <a href="_routes_8cs_source.html#l00140">Routes.cs:140</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_routes_html_aeb032cc314264cd0214895fe0c6b7670"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#aeb032cc314264cd0214895fe0c6b7670">Tgstation.Server.Api.Routes.Logs</a></div><div class="ttdeci">const string Logs</div><div class="ttdoc">The endpoint to download server logs.</div><div class="ttdef"><b>Definition</b> <a href="_routes_8cs_source.html#l00033">Routes.cs:33</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_administration_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html">Tgstation.Server.Client.AdministrationClient</a></div><div class="ttdef"><b>Definition</b> <a href="_administration_client_8cs_source.html#l00015">AdministrationClient.cs:16</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_administration_client_html_a3a5d6656c8ffc30db1d0d115b2a34c00"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a3a5d6656c8ffc30db1d0d115b2a34c00">Tgstation.Server.Client.AdministrationClient.GetLog</a></div><div class="ttdeci">async ValueTask&lt; Tuple&lt; LogFileResponse, Stream &gt; &gt; GetLog(LogFileResponse logFile, CancellationToken cancellationToken)</div><div class="ttdoc">Download a given logFile .A ValueTask&lt;TResult&gt; resulting a Tuple&lt;T1, T2&gt; containing the downloaded Lo...</div><div class="ttdef"><b>Definition</b> <a href="_administration_client_8cs_source.html#l00060">AdministrationClient.cs:60</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_administration_client_html_a5f279845f5b5a8dcd837bbf99ff06b9b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a5f279845f5b5a8dcd837bbf99ff06b9b">Tgstation.Server.Client.AdministrationClient.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.A ValueTask&lt;TResult&gt; resulting in an List&lt;T&gt; of LogFileRes...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_administration_client_html_a6a88406ff2dd9da8c10973db48f54070"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a6a88406ff2dd9da8c10973db48f54070">Tgstation.Server.Client.AdministrationClient.Update</a></div><div class="ttdeci">async ValueTask&lt; ServerUpdateResponse &gt; Update(ServerUpdateRequest updateRequest, Stream? zipFileStream, CancellationToken cancellationToken)</div><div class="ttdoc">Updates the AdministrationResponse setttings.A ValueTask&lt;TResult&gt; resulting in the echoed ServerUpdat...</div><div class="ttdef"><b>Definition</b> <a href="_administration_client_8cs_source.html#l00030">AdministrationClient.cs:30</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_administration_client_html_a9ec9efd0a58b3ceb62dc114c097a6eb9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#a9ec9efd0a58b3ceb62dc114c097a6eb9">Tgstation.Server.Client.AdministrationClient.Read</a></div><div class="ttdeci">ValueTask&lt; AdministrationResponse &gt; Read(bool forceFresh, CancellationToken cancellationToken)</div><div class="ttdoc">Get the AdministrationResponse represented by the IAdministrationClient.A ValueTask&lt;TResult&gt; resultin...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_administration_client_html_aa5d48433766cd2f29ee60007767f5387"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#aa5d48433766cd2f29ee60007767f5387">Tgstation.Server.Client.AdministrationClient.AdministrationClient</a></div><div class="ttdeci">AdministrationClient(IApiClient apiClient)</div><div class="ttdoc">Initializes a new instance of the AdministrationClient class.</div><div class="ttdef"><b>Definition</b> <a href="_administration_client_8cs_source.html#l00021">AdministrationClient.cs:21</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_administration_client_html_afd86486b34f0abb341fba11503edce77"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_administration_client.html#afd86486b34f0abb341fba11503edce77">Tgstation.Server.Client.AdministrationClient.Restart</a></div><div class="ttdeci">ValueTask Restart(CancellationToken cancellationToken)</div><div class="ttdoc">Restarts the TGS server.A ValueTask representing the running operation.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_api_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">Tgstation.Server.Client.ApiClient</a></div><div class="ttdef"><b>Definition</b> <a href="_api_client_8cs_source.html#l00034">ApiClient.cs:35</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_api_client_html_a0a6186386ebd4d1ef1c9cec46a381d9a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html#a0a6186386ebd4d1ef1c9cec46a381d9a">Tgstation.Server.Client.ApiClient.Download</a></div><div class="ttdeci">ValueTask&lt; Stream &gt; Download(FileTicketResponse ticket, CancellationToken cancellationToken)</div><div class="ttdoc">Downloads a file Stream for a given ticket .A ValueTask&lt;TResult&gt; resulting in the downloaded Stream.</div><div class="ttdef"><b>Definition</b> <a href="_api_client_8cs_source.html#l00285">ApiClient.cs:285</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_api_client_html_a2962556fb0b3a82c83593d23d70ace2a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html#a2962556fb0b3a82c83593d23d70ace2a">Tgstation.Server.Client.ApiClient.Upload</a></div><div class="ttdeci">async ValueTask Upload(FileTicketResponse ticket, Stream? uploadStream, CancellationToken cancellationToken)</div><div class="ttdoc">Uploads a given uploadStream for a given ticket .A ValueTask representing the running operation.</div><div class="ttdef"><b>Definition</b> <a href="_api_client_8cs_source.html#l00300">ApiClient.cs:300</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_api_client_html_a3db5ef824b0f9492d416bc1fdd8b1984"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html#a3db5ef824b0f9492d416bc1fdd8b1984">Tgstation.Server.Client.ApiClient.Delete</a></div><div class="ttdeci">ValueTask Delete(string route, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP DELETE request.A ValueTask representing the running operation.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_paginated_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_paginated_client.html">Tgstation.Server.Client.PaginatedClient</a></div><div class="ttdoc">Client that deals with getting paginated results.</div><div class="ttdef"><b>Definition</b> <a href="_paginated_client_8cs_source.html#l00016">PaginatedClient.cs:17</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_api_client_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html">Tgstation.Server.Client.IApiClient</a></div><div class="ttdoc">Web interface for the API.</div><div class="ttdef"><b>Definition</b> <a href="_i_api_client_8cs_source.html#l00016">IApiClient.cs:17</a></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_api_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api.html">Tgstation.Server.Api</a></div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00019">ApiHeaders.cs:20</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