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

181 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/Components/EngineClient.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><li class="navelem"><a class="el" href="dir_6c60df807dd2523776d391746c262b4d.html">Components</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">EngineClient.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_engine_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.html">Tgstation.Server.Api</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.html">Tgstation.Server.Api.Models</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_1_1_components.html">Tgstation.Server.Client.Components</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_components_1_1_engine_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_components_1_1_engine_client.html">EngineClient</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_components_1_1_i_engine_client.html">IEngineClient</a></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0ea399ad5bbe707da9496c63a91d786f"> 20</a></span> readonly <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_instance.html">Instance</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0ea399ad5bbe707da9496c63a91d786f">instance</a>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="foldopen" id="foldopen00027" data-start="{" data-end="}">
<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_components_1_1_engine_client.html#a4a2d1b5c6fc6e672ea15c0cd15b49580"> 27</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a4a2d1b5c6fc6e672ea15c0cd15b49580">EngineClient</a>(<a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html">IApiClient</a> apiClient, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_instance.html">Instance</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0ea399ad5bbe707da9496c63a91d786f">instance</a>)</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> : base(apiClient)</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> this.instance = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0ea399ad5bbe707da9496c63a91d786f">instance</a> ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0ea399ad5bbe707da9496c63a91d786f">instance</a>));</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> }</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a13e0def771cb4ba38b97a579c350a474"> 34</a></span> <span class="keyword">public</span> ValueTask&lt;EngineResponse&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a13e0def771cb4ba38b97a579c350a474">ActiveVersion</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>.Read&lt;<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_engine_response.html">EngineResponse</a>&gt;(<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#ab646ee226b5038f86d679bc9342320b3">Engine</a>, <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0ea399ad5bbe707da9496c63a91d786f">instance</a>.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html#ae31e478e1d338b37a14565df6fd58570">Id</a>!.Value, cancellationToken);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</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_client_1_1_components_1_1_engine_client.html#acc6043983bfd594a90764a9ff47757f6"> 37</a></span> <span class="keyword">public</span> ValueTask&lt;JobResponse&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#acc6043983bfd594a90764a9ff47757f6">DeleteVersion</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_engine_version_delete_request.html">EngineVersionDeleteRequest</a> deleteRequest, CancellationToken cancellationToken)</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#ac966a2d8864a14d88284a6c9a9b7a7b7"> 38</a></span> =&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>&lt;<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_engine_version_delete_request.html">EngineVersionDeleteRequest</a>, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_job_response.html">JobResponse</a>&gt;(<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#ab646ee226b5038f86d679bc9342320b3">Engine</a>, deleteRequest, <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0ea399ad5bbe707da9496c63a91d786f">instance</a>.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html#ae31e478e1d338b37a14565df6fd58570">Id</a>!.Value, cancellationToken);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a6c30137296557a23505965065d3ee849"> 41</a></span> <span class="keyword">public</span> ValueTask&lt;List&lt;EngineResponse&gt;&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a6c30137296557a23505965065d3ee849">InstalledVersions</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="l00042" name="l00042"></a><span class="lineno"> 42</span> =&gt; ReadPaged&lt;EngineResponse&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_function" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a21a829d350fad918024f30fc9330a8e2">ListRoute</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#ab646ee226b5038f86d679bc9342320b3">Engine</a>), <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0ea399ad5bbe707da9496c63a91d786f">instance</a>.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html#ae31e478e1d338b37a14565df6fd58570">Id</a>, cancellationToken);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="foldopen" id="foldopen00045" data-start="{" data-end="}">
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0fe00fe94595a4fbcf97a2b11ec45086"> 45</a></span> <span class="keyword">public</span> async ValueTask&lt;EngineInstallResponse&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0fe00fe94595a4fbcf97a2b11ec45086">SetActiveVersion</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_engine_version_request.html">EngineVersionRequest</a> installRequest, <a class="code hl_class" href="class_stream.html">Stream</a>? zipFileStream, CancellationToken cancellationToken)</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">if</span> (installRequest == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(installRequest));</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">if</span> (installRequest.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_engine_version_request.html#a3e507e7137cc4659ca45119cc06685f5">UploadCustomZip</a> == <span class="keyword">true</span> &amp;&amp; zipFileStream == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(zipFileStream));</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</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_engine_version_request.html">EngineVersionRequest</a>, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_engine_install_response.html">EngineInstallResponse</a>&gt;(</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</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#ab646ee226b5038f86d679bc9342320b3">Engine</a>,</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> installRequest,</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0ea399ad5bbe707da9496c63a91d786f">instance</a>.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html#ae31e478e1d338b37a14565df6fd58570">Id</a>!.Value,</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> cancellationToken)</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> .ConfigureAwait(<span class="keyword">false</span>);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">if</span> (installRequest.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_engine_version_request.html#a3e507e7137cc4659ca45119cc06685f5">UploadCustomZip</a> == <span class="keyword">true</span>)</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</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="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordflow">return</span> result;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> }</div>
</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> }</div>
</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</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_entity_id_html_ae31e478e1d338b37a14565df6fd58570"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html#ae31e478e1d338b37a14565df6fd58570">Tgstation.Server.Api.Models.EntityId.Id</a></div><div class="ttdeci">virtual ? long Id</div><div class="ttdoc">The ID of the entity.</div><div class="ttdef"><b>Definition</b> <a href="_entity_id_8cs_source.html#l00014">EntityId.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_instance_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_instance.html">Tgstation.Server.Api.Models.Instance</a></div><div class="ttdoc">Metadata about a server instance.</div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_instance_8cs_source.html#l00008">Instance.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_engine_version_delete_request_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_engine_version_delete_request.html">Tgstation.Server.Api.Models.Request.EngineVersionDeleteRequest</a></div><div class="ttdoc">A request to delete a specific EngineVersion.</div><div class="ttdef"><b>Definition</b> <a href="_engine_version_delete_request_8cs_source.html#l00006">EngineVersionDeleteRequest.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_engine_version_request_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_engine_version_request.html">Tgstation.Server.Api.Models.Request.EngineVersionRequest</a></div><div class="ttdoc">A request to switch to a given EngineVersion.</div><div class="ttdef"><b>Definition</b> <a href="_engine_version_request_8cs_source.html#l00006">EngineVersionRequest.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_engine_version_request_html_a3e507e7137cc4659ca45119cc06685f5"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_engine_version_request.html#a3e507e7137cc4659ca45119cc06685f5">Tgstation.Server.Api.Models.Request.EngineVersionRequest.UploadCustomZip</a></div><div class="ttdeci">bool? UploadCustomZip</div><div class="ttdoc">If a custom BYOND version is to be uploaded.</div><div class="ttdef"><b>Definition</b> <a href="_engine_version_request_8cs_source.html#l00016">EngineVersionRequest.cs:16</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_engine_install_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_engine_install_response.html">Tgstation.Server.Api.Models.Response.EngineInstallResponse</a></div><div class="ttdoc">Represents an engine installation job. FileTicketResponse.FileTicket is used to upload custom version...</div><div class="ttdef"><b>Definition</b> <a href="_engine_install_response_8cs_source.html#l00006">EngineInstallResponse.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_engine_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_engine_response.html">Tgstation.Server.Api.Models.Response.EngineResponse</a></div><div class="ttdoc">Represents an installed Models.EngineVersion.</div><div class="ttdef"><b>Definition</b> <a href="_engine_response_8cs_source.html#l00006">EngineResponse.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_job_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_job_response.html">Tgstation.Server.Api.Models.Response.JobResponse</a></div><div class="ttdoc">Represents a long running job on the server. Model is read-only, updates attempt to cancel the job.</div><div class="ttdef"><b>Definition</b> <a href="_job_response_8cs_source.html#l00006">JobResponse.cs:7</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_a21a829d350fad918024f30fc9330a8e2"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a21a829d350fad918024f30fc9330a8e2">Tgstation.Server.Api.Routes.ListRoute</a></div><div class="ttdeci">static string ListRoute(string route)</div><div class="ttdoc">Get the /List postfix for a route .</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_routes_html_ab646ee226b5038f86d679bc9342320b3"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#ab646ee226b5038f86d679bc9342320b3">Tgstation.Server.Api.Routes.Engine</a></div><div class="ttdeci">const string Engine</div><div class="ttdoc">The engine controller.</div><div class="ttdef"><b>Definition</b> <a href="_routes_8cs_source.html#l00053">Routes.cs:53</a></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_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_components_1_1_engine_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html">Tgstation.Server.Client.Components.EngineClient</a></div><div class="ttdef"><b>Definition</b> <a href="_engine_client_8cs_source.html#l00015">EngineClient.cs:16</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client_html_a0ea399ad5bbe707da9496c63a91d786f"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0ea399ad5bbe707da9496c63a91d786f">Tgstation.Server.Client.Components.EngineClient.instance</a></div><div class="ttdeci">readonly Instance instance</div><div class="ttdoc">The Instance for the EngineClient.</div><div class="ttdef"><b>Definition</b> <a href="_engine_client_8cs_source.html#l00020">EngineClient.cs:20</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client_html_a0fe00fe94595a4fbcf97a2b11ec45086"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a0fe00fe94595a4fbcf97a2b11ec45086">Tgstation.Server.Client.Components.EngineClient.SetActiveVersion</a></div><div class="ttdeci">async ValueTask&lt; EngineInstallResponse &gt; SetActiveVersion(EngineVersionRequest installRequest, Stream? zipFileStream, CancellationToken cancellationToken)</div><div class="ttdoc">Updates the active engine version.A ValueTask&lt;TResult&gt; resulting in the EngineInstallResponse.</div><div class="ttdef"><b>Definition</b> <a href="_engine_client_8cs_source.html#l00045">EngineClient.cs:45</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client_html_a13e0def771cb4ba38b97a579c350a474"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a13e0def771cb4ba38b97a579c350a474">Tgstation.Server.Client.Components.EngineClient.ActiveVersion</a></div><div class="ttdeci">ValueTask&lt; EngineResponse &gt; ActiveVersion(CancellationToken cancellationToken)</div><div class="ttdoc">Get the EngineInstallResponse active Api.Models.EngineVersion.A ValueTask&lt;TResult&gt; resulting in the E...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client_html_a4a2d1b5c6fc6e672ea15c0cd15b49580"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a4a2d1b5c6fc6e672ea15c0cd15b49580">Tgstation.Server.Client.Components.EngineClient.EngineClient</a></div><div class="ttdeci">EngineClient(IApiClient apiClient, Instance instance)</div><div class="ttdoc">Initializes a new instance of the EngineClient class.</div><div class="ttdef"><b>Definition</b> <a href="_engine_client_8cs_source.html#l00027">EngineClient.cs:27</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client_html_a6c30137296557a23505965065d3ee849"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#a6c30137296557a23505965065d3ee849">Tgstation.Server.Client.Components.EngineClient.InstalledVersions</a></div><div class="ttdeci">ValueTask&lt; List&lt; EngineResponse &gt; &gt; InstalledVersions(PaginationSettings? paginationSettings, CancellationToken cancellationToken)</div><div class="ttdoc">Get all installed EngineInstallResponse System.Versions.A ValueTask&lt;TResult&gt; resulting in an List&lt;T&gt; ...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client_html_acc6043983bfd594a90764a9ff47757f6"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html#acc6043983bfd594a90764a9ff47757f6">Tgstation.Server.Client.Components.EngineClient.DeleteVersion</a></div><div class="ttdeci">ValueTask&lt; JobResponse &gt; DeleteVersion(EngineVersionDeleteRequest deleteRequest, CancellationToken cancellationToken)</div><div class="ttdoc">Starts a job to delete a specific engine version.A ValueTask&lt;TResult&gt; resulting in the JobResponse fo...</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_components_1_1_i_engine_client_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_components_1_1_i_engine_client.html">Tgstation.Server.Client.Components.IEngineClient</a></div><div class="ttdoc">For managing the engine installations.</div><div class="ttdef"><b>Definition</b> <a href="_i_engine_client_8cs_source.html#l00014">IEngineClient.cs:15</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_1_1_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a></div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html#l00005">ChatChannel.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_1_1_components_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_client_1_1_components.html">Tgstation.Server.Client.Components</a></div><div class="ttdef"><b>Definition</b> <a href="_chat_bots_client_8cs_source.html#l00011">ChatBotsClient.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