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

208 lines
42 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/RestServerClient.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">RestServerClient.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_rest_server_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.Threading;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Threading.Tasks;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>Microsoft.AspNetCore.SignalR.Client;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>Microsoft.Extensions.Logging;</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_hubs.html">Tgstation.Server.Api.Hubs</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_rest_server_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_rest_server_client.html">RestServerClient</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client.html">IRestServerClient</a></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a4dc213d40dfa475586fc89b5f545c3d1"> 18</a></span> <span class="keyword">public</span> Uri <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a4dc213d40dfa475586fc89b5f545c3d1">Url</a> =&gt; <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>.<a class="code hl_property" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a0efbf73e1dfbee520ceafa593ee2ec51">Url</a>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</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_rest_server_client.html#aa0cf44566a9873b24522c450c236b8da"> 21</a></span> <span class="keyword">public</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html">TokenResponse</a> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#aa0cf44566a9873b24522c450c236b8da">Token</a></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> {</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">get</span> =&gt; apiClient.Headers.Token ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> InvalidOperationException(<span class="stringliteral">&quot;apiClient.Headers.Token was null!&quot;</span>);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">set</span> =&gt; apiClient.Headers = <span class="keyword">new</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>.<a class="code hl_property" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#afb0feaf84640f44711b635836bf9378e">Headers</a>.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a0562061dc87df56fe1e6875556f535b9">UserAgent</a>!, value);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div>
</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="foldopen" id="foldopen00028" data-start="{" data-end="};">
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a4ef66492877abf1bca811798a9e51261"> 28</a></span> <span class="keyword">public</span> TimeSpan <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a4ef66492877abf1bca811798a9e51261">Timeout</a></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> <span class="keyword">get</span> =&gt; <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>.<a class="code hl_property" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a92b092701f159c344a3c78be34161ecf">Timeout</a>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">set</span> =&gt; apiClient.Timeout = value;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> }</div>
</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a6bb44f622b1cf551cecab96468585643"> 35</a></span> <span class="keyword">public</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_instance_manager_client.html">IInstanceManagerClient</a> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a6bb44f622b1cf551cecab96468585643">Instances</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </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_rest_server_client.html#a57201395270adceaca138d68db2a7fc7"> 38</a></span> <span class="keyword">public</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_administration_client.html">IAdministrationClient</a> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a57201395270adceaca138d68db2a7fc7">Administration</a> { <span class="keyword">get</span>; }</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_rest_server_client.html#a14dbaddee66a344844f0e73ea584962b"> 41</a></span> <span class="keyword">public</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html">IUsersClient</a> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a14dbaddee66a344844f0e73ea584962b">Users</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#acd5c6918ff5ac5ece3aac5549068664d"> 44</a></span> <span class="keyword">public</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_user_groups_client.html">IUserGroupsClient</a> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#acd5c6918ff5ac5ece3aac5549068664d">Groups</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#ad5a224203d2d864bba1776fcd9996519"> 47</a></span> <span class="keyword">public</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_transfer_client.html">ITransferClient</a> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#ad5a224203d2d864bba1776fcd9996519">Transfer</a> =&gt; <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b"> 52</a></span> readonly <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html">IApiClient</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="foldopen" id="foldopen00058" data-start="{" data-end="}">
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#af411ca606a4807bbe39b6b59fe884007"> 58</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#af411ca606a4807bbe39b6b59fe884007">RestServerClient</a>(<a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html">IApiClient</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>)</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> this.apiClient = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</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_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>));</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> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a6bb44f622b1cf551cecab96468585643">Instances</a> = <span class="keyword">new</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html">InstanceManagerClient</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a14dbaddee66a344844f0e73ea584962b">Users</a> = <span class="keyword">new</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html">UsersClient</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a57201395270adceaca138d68db2a7fc7">Administration</a> = <span class="keyword">new</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_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#acd5c6918ff5ac5ece3aac5549068664d">Groups</a> = <span class="keyword">new</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_user_groups_client.html">UserGroupsClient</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div>
</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#aa0f8b50627abfa0b4c3aa9f1658e317f"> 69</a></span> <span class="keyword">public</span> ValueTask <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#aa0f8b50627abfa0b4c3aa9f1658e317f">DisposeAsync</a>() =&gt; <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>.DisposeAsync();</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#aafd9de54ed6b9856feb20181d5a62d73"> 72</a></span> <span class="keyword">public</span> ValueTask&lt;ServerInformationResponse&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#aafd9de54ed6b9856feb20181d5a62d73">ServerInformation</a>(CancellationToken cancellationToken) =&gt; <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">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_server_information_response.html">ServerInformationResponse</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#a8c6219903a85b89432912919b1762e49">ApiRoot</a>, cancellationToken);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a9a7acfc2ad52f44548bd1ab8e54d61c5"> 75</a></span> <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a9a7acfc2ad52f44548bd1ab8e54d61c5">AddRequestLogger</a>(<a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_request_logger.html">IRequestLogger</a> requestLogger) =&gt; <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>.<a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a55853418698889c9f90804d1e9067b51">AddRequestLogger</a>(requestLogger);</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a851fe8e43a5fe871d257794caa393dd9"> 78</a></span> <span class="keyword">public</span> ValueTask&lt;IAsyncDisposable&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a851fe8e43a5fe871d257794caa393dd9">SubscribeToJobUpdates</a>(</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_api_1_1_hubs_1_1_i_jobs_hub.html">IJobsHub</a> jobsReceiver,</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_class" href="class_i_retry_policy.html">IRetryPolicy</a>? retryPolicy,</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> Action&lt;ILoggingBuilder&gt;? loggingConfigureAction,</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> CancellationToken cancellationToken)</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> =&gt; <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">apiClient</a>.CreateHubConnection(jobsReceiver, retryPolicy, loggingConfigureAction, cancellationToken);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> }</div>
</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span>}</div>
<div class="ttc" id="aclass_i_retry_policy_html"><div class="ttname"><a href="class_i_retry_policy.html">IRetryPolicy</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_api_headers_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">Tgstation.Server.Api.ApiHeaders</a></div><div class="ttdoc">Represents the header that must be present for every server request.</div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00024">ApiHeaders.cs:25</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_api_headers_html_a0562061dc87df56fe1e6875556f535b9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a0562061dc87df56fe1e6875556f535b9">Tgstation.Server.Api.ApiHeaders.UserAgent</a></div><div class="ttdeci">ProductHeaderValue? UserAgent</div><div class="ttdoc">The client's user agent as a ProductHeaderValue if valid.</div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00089">ApiHeaders.cs:89</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html">Tgstation.Server.Api.Models.Response.ServerInformationResponse</a></div><div class="ttdoc">Represents basic server information.</div><div class="ttdef"><b>Definition</b> <a href="_server_information_response_8cs_source.html#l00009">ServerInformationResponse.cs:10</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html">Tgstation.Server.Api.Models.Response.TokenResponse</a></div><div class="ttdoc">Represents a JWT returned by the API.</div><div class="ttdef"><b>Definition</b> <a href="_token_response_8cs_source.html#l00008">TokenResponse.cs:9</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_a8c6219903a85b89432912919b1762e49"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a8c6219903a85b89432912919b1762e49">Tgstation.Server.Api.Routes.ApiRoot</a></div><div class="ttdeci">const string ApiRoot</div><div class="ttdoc">The root of API methods.</div><div class="ttdef"><b>Definition</b> <a href="_routes_8cs_source.html#l00013">Routes.cs:13</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_instance_manager_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html">Tgstation.Server.Client.InstanceManagerClient</a></div><div class="ttdef"><b>Definition</b> <a href="_instance_manager_client_8cs_source.html#l00015">InstanceManagerClient.cs:16</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html">Tgstation.Server.Client.RestServerClient</a></div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00015">RestServerClient.cs:16</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_a14dbaddee66a344844f0e73ea584962b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a14dbaddee66a344844f0e73ea584962b">Tgstation.Server.Client.RestServerClient.Users</a></div><div class="ttdeci">IUsersClient Users</div><div class="ttdoc">Access the IUsersClient.</div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00041">RestServerClient.cs:41</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_a4dc213d40dfa475586fc89b5f545c3d1"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a4dc213d40dfa475586fc89b5f545c3d1">Tgstation.Server.Client.RestServerClient.Url</a></div><div class="ttdeci">Uri Url</div><div class="ttdoc">The connected server's root Uri.</div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00018">RestServerClient.cs:18</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_a4ef66492877abf1bca811798a9e51261"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a4ef66492877abf1bca811798a9e51261">Tgstation.Server.Client.RestServerClient.Timeout</a></div><div class="ttdeci">TimeSpan Timeout</div><div class="ttdoc">The connection timeout.</div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00028">RestServerClient.cs:29</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_a57201395270adceaca138d68db2a7fc7"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a57201395270adceaca138d68db2a7fc7">Tgstation.Server.Client.RestServerClient.Administration</a></div><div class="ttdeci">IAdministrationClient Administration</div><div class="ttdoc">Access the IAdministrationClient.</div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00038">RestServerClient.cs:38</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_a6bb44f622b1cf551cecab96468585643"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a6bb44f622b1cf551cecab96468585643">Tgstation.Server.Client.RestServerClient.Instances</a></div><div class="ttdeci">IInstanceManagerClient Instances</div><div class="ttdoc">Access the IInstanceManagerClient.</div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00035">RestServerClient.cs:35</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_a7329983651ee9b0e287b73f53512f05b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a7329983651ee9b0e287b73f53512f05b">Tgstation.Server.Client.RestServerClient.apiClient</a></div><div class="ttdeci">readonly IApiClient apiClient</div><div class="ttdoc">The IApiClient for the RestServerClient.</div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00052">RestServerClient.cs:52</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_a851fe8e43a5fe871d257794caa393dd9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a851fe8e43a5fe871d257794caa393dd9">Tgstation.Server.Client.RestServerClient.SubscribeToJobUpdates</a></div><div class="ttdeci">ValueTask&lt; IAsyncDisposable &gt; SubscribeToJobUpdates(IJobsHub jobsReceiver, IRetryPolicy? retryPolicy, Action&lt; ILoggingBuilder &gt;? loggingConfigureAction, CancellationToken cancellationToken)</div><div class="ttdoc">Subscribe to all job updates available to the IRestServerClient.An IAsyncDisposable representing the ...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_a9a7acfc2ad52f44548bd1ab8e54d61c5"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#a9a7acfc2ad52f44548bd1ab8e54d61c5">Tgstation.Server.Client.RestServerClient.AddRequestLogger</a></div><div class="ttdeci">void AddRequestLogger(IRequestLogger requestLogger)</div><div class="ttdoc">Adds a requestLogger to the request pipeline.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_aa0cf44566a9873b24522c450c236b8da"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#aa0cf44566a9873b24522c450c236b8da">Tgstation.Server.Client.RestServerClient.Token</a></div><div class="ttdeci">TokenResponse Token</div><div class="ttdoc">The Token used to access the server.</div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00021">RestServerClient.cs:22</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_aa0f8b50627abfa0b4c3aa9f1658e317f"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#aa0f8b50627abfa0b4c3aa9f1658e317f">Tgstation.Server.Client.RestServerClient.DisposeAsync</a></div><div class="ttdeci">ValueTask DisposeAsync()</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_aafd9de54ed6b9856feb20181d5a62d73"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#aafd9de54ed6b9856feb20181d5a62d73">Tgstation.Server.Client.RestServerClient.ServerInformation</a></div><div class="ttdeci">ValueTask&lt; ServerInformationResponse &gt; ServerInformation(CancellationToken cancellationToken)</div><div class="ttdoc">The ServerInformationResponse of the IRestServerClient.A Task&lt;TResult&gt; resulting in the ServerInforma...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_acd5c6918ff5ac5ece3aac5549068664d"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#acd5c6918ff5ac5ece3aac5549068664d">Tgstation.Server.Client.RestServerClient.Groups</a></div><div class="ttdeci">IUserGroupsClient Groups</div><div class="ttdoc">Access the IUserGroupsClient.</div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00044">RestServerClient.cs:44</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_ad5a224203d2d864bba1776fcd9996519"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#ad5a224203d2d864bba1776fcd9996519">Tgstation.Server.Client.RestServerClient.Transfer</a></div><div class="ttdeci">ITransferClient Transfer</div><div class="ttdoc">Access the ITransferClient.Most client methods handle transfers in their invocations....</div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00047">RestServerClient.cs:47</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rest_server_client_html_af411ca606a4807bbe39b6b59fe884007"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rest_server_client.html#af411ca606a4807bbe39b6b59fe884007">Tgstation.Server.Client.RestServerClient.RestServerClient</a></div><div class="ttdeci">RestServerClient(IApiClient apiClient)</div><div class="ttdoc">Initializes a new instance of the RestServerClient class.</div><div class="ttdef"><b>Definition</b> <a href="_rest_server_client_8cs_source.html#l00058">RestServerClient.cs:58</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_user_groups_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_user_groups_client.html">Tgstation.Server.Client.UserGroupsClient</a></div><div class="ttdef"><b>Definition</b> <a href="_user_groups_client_8cs_source.html#l00014">UserGroupsClient.cs:15</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_users_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html">Tgstation.Server.Client.UsersClient</a></div><div class="ttdef"><b>Definition</b> <a href="_users_client_8cs_source.html#l00014">UsersClient.cs:15</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_api_1_1_hubs_1_1_i_jobs_hub_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_api_1_1_hubs_1_1_i_jobs_hub.html">Tgstation.Server.Api.Hubs.IJobsHub</a></div><div class="ttdoc">SignalR client methods for receiving JobResponses.</div><div class="ttdef"><b>Definition</b> <a href="_i_jobs_hub_8cs_source.html#l00011">IJobsHub.cs:12</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="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a0efbf73e1dfbee520ceafa593ee2ec51"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a0efbf73e1dfbee520ceafa593ee2ec51">Tgstation.Server.Client.IApiClient.Url</a></div><div class="ttdeci">Uri Url</div><div class="ttdoc">The Uri pointing the tgstation-server.</div><div class="ttdef"><b>Definition</b> <a href="_i_api_client_8cs_source.html#l00026">IApiClient.cs:26</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a55853418698889c9f90804d1e9067b51"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a55853418698889c9f90804d1e9067b51">Tgstation.Server.Client.IApiClient.AddRequestLogger</a></div><div class="ttdeci">void AddRequestLogger(IRequestLogger requestLogger)</div><div class="ttdoc">Adds a requestLogger to the request pipeline.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a92b092701f159c344a3c78be34161ecf"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a92b092701f159c344a3c78be34161ecf">Tgstation.Server.Client.IApiClient.Timeout</a></div><div class="ttdeci">TimeSpan Timeout</div><div class="ttdoc">The request timeout.</div><div class="ttdef"><b>Definition</b> <a href="_i_api_client_8cs_source.html#l00031">IApiClient.cs:31</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_afb0feaf84640f44711b635836bf9378e"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#afb0feaf84640f44711b635836bf9378e">Tgstation.Server.Client.IApiClient.Headers</a></div><div class="ttdeci">ApiHeaders Headers</div><div class="ttdoc">The ApiHeaders the IApiClient uses.</div><div class="ttdef"><b>Definition</b> <a href="_i_api_client_8cs_source.html#l00021">IApiClient.cs:21</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_instance_manager_client_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_instance_manager_client.html">Tgstation.Server.Client.IInstanceManagerClient</a></div><div class="ttdoc">For managing Instances.</div><div class="ttdef"><b>Definition</b> <a href="_i_instance_manager_client_8cs_source.html#l00015">IInstanceManagerClient.cs:16</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_request_logger_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_request_logger.html">Tgstation.Server.Client.IRequestLogger</a></div><div class="ttdoc">For logging HTTP requests and responses.</div><div class="ttdef"><b>Definition</b> <a href="_i_request_logger_8cs_source.html#l00010">IRequestLogger.cs:11</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client.html">Tgstation.Server.Client.IRestServerClient</a></div><div class="ttdoc">Main client for communicating with a server.</div><div class="ttdef"><b>Definition</b> <a href="_i_rest_server_client_8cs_source.html#l00016">IRestServerClient.cs:17</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_transfer_client_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_transfer_client.html">Tgstation.Server.Client.ITransferClient</a></div><div class="ttdoc">For transferring data Streams.</div><div class="ttdef"><b>Definition</b> <a href="_i_transfer_client_8cs_source.html#l00012">ITransferClient.cs:13</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_user_groups_client_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_user_groups_client.html">Tgstation.Server.Client.IUserGroupsClient</a></div><div class="ttdoc">For managing UserGroupResponses.</div><div class="ttdef"><b>Definition</b> <a href="_i_user_groups_client_8cs_source.html#l00014">IUserGroupsClient.cs:15</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_users_client_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html">Tgstation.Server.Client.IUsersClient</a></div><div class="ttdoc">For managing UserResponses.</div><div class="ttdef"><b>Definition</b> <a href="_i_users_client_8cs_source.html#l00014">IUsersClient.cs:15</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_hubs_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_hubs.html">Tgstation.Server.Api.Hubs</a></div><div class="ttdef"><b>Definition</b> <a href="_i_jobs_hub_8cs_source.html#l00006">IJobsHub.cs:7</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