mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-24 21:46:52 +01:00
200 lines
32 KiB
HTML
200 lines
32 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>tgstation-server: src/Tgstation.Server.Client/IApiClient.cs Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">tgstation-server<span id="projectnumber"> 6.19.3</span>
|
|
</div>
|
|
<div id="projectbrief">The /tg/station 13 server suite</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_9826fb2d31585a830723e6d7089b5d0e.html">Tgstation.Server.Client</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">IApiClient.cs</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_i_api_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_models.html">Tgstation.Server.Api.Models</a>;</div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</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="l00012" name="l00012"></a><span class="lineno"> 12</span>{</div>
|
|
<div class="foldopen" id="foldopen00016" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html"> 16</a></span> <span class="keyword">interface </span><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_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_transfer_client.html">ITransferClient</a>, <a class="code hl_class" href="class_i_async_disposable.html">IAsyncDisposable</a></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> {</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#afb0feaf84640f44711b635836bf9378e"> 21</a></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_property" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#afb0feaf84640f44711b635836bf9378e">Headers</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a0efbf73e1dfbee520ceafa593ee2ec51"> 26</a></span> Uri <a class="code hl_property" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a0efbf73e1dfbee520ceafa593ee2ec51">Url</a> { <span class="keyword">get</span>; }</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a92b092701f159c344a3c78be34161ecf"> 31</a></span> TimeSpan <a class="code hl_property" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a92b092701f159c344a3c78be34161ecf">Timeout</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a55853418698889c9f90804d1e9067b51"> 37</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a55853418698889c9f90804d1e9067b51">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);</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> ValueTask<IAsyncDisposable> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a1d7641b8a35e5ff8e2ab72db7e4d52c0">CreateHubConnection<THubImplementation></a>(</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> THubImplementation hubImplementation,</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_class" href="class_i_retry_policy.html">IRetryPolicy</a>? retryPolicy,</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> Action<ILoggingBuilder>? loggingConfigureAction,</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> CancellationToken cancellationToken)</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> where THubImplementation : <span class="keyword">class</span>;</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a0520e3f39c179638f3d7b50ae248ef7d">Create<TBody, TResult></a>(<span class="keywordtype">string</span> route, TBody body, CancellationToken cancellationToken)</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> where TBody : <span class="keyword">class</span>;</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a482fc5929a49142b76dd5370e96c526e">Create<TResult></a>(<span class="keywordtype">string</span> route, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a8dd4bcc45d323460eda585f3b2304607">Read<TResult></a>(<span class="keywordtype">string</span> route, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#accf90de7f179b289eab1476386942c13">Update<TBody, TResult></a>(<span class="keywordtype">string</span> route, TBody body, CancellationToken cancellationToken)</div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> where TBody : <span class="keyword">class</span>;</div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a271d7164da269f3c130c6275febae935">Update<TResult></a>(<span class="keywordtype">string</span> route, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a213b113fb0bcf8056fdc52dcfdce239c"> 114</a></span> ValueTask <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a213b113fb0bcf8056fdc52dcfdce239c">Update<TBody></a>(<span class="keywordtype">string</span> route, TBody body, CancellationToken cancellationToken)</div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> where TBody : <span class="keyword">class</span>;</div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a3e243ce6c09deb68c28dccd05a8d50ca"> 123</a></span> ValueTask <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a3e243ce6c09deb68c28dccd05a8d50ca">Patch</a>(<span class="keywordtype">string</span> route, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#abdaa2e300032ff65a06e492a2b40e218"> 131</a></span> ValueTask <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a6120f26a5fd0cf6319b11d4249296b47">Delete</a>(<span class="keywordtype">string</span> route, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a0520e3f39c179638f3d7b50ae248ef7d">Create<TBody, TResult></a>(</div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <span class="keywordtype">string</span> route,</div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> TBody body,</div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <span class="keywordtype">long</span> instanceId,</div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> CancellationToken cancellationToken)</div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> where TBody : <span class="keyword">class</span>;</div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> </div>
|
|
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a482fc5929a49142b76dd5370e96c526e">Create<TResult></a>(<span class="keywordtype">string</span> route, <span class="keywordtype">long</span> instanceId, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> </div>
|
|
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a6c9dbcbf335c17714d4450a73698c92c">Patch<TResult></a>(<span class="keywordtype">string</span> route, <span class="keywordtype">long</span> instanceId, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> </div>
|
|
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a8dd4bcc45d323460eda585f3b2304607">Read<TResult></a>(<span class="keywordtype">string</span> route, <span class="keywordtype">long</span> instanceId, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> </div>
|
|
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#accf90de7f179b289eab1476386942c13">Update<TBody, TResult></a>(</div>
|
|
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> <span class="keywordtype">string</span> route,</div>
|
|
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> TBody body,</div>
|
|
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> <span class="keywordtype">long</span> instanceId,</div>
|
|
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> CancellationToken cancellationToken)</div>
|
|
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> where TBody : <span class="keyword">class</span>;</div>
|
|
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> </div>
|
|
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#abf63ca32d7f8c2f1eab46175aade045b"> 204</a></span> ValueTask <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#abf63ca32d7f8c2f1eab46175aade045b">Delete</a>(<span class="keywordtype">string</span> route, <span class="keywordtype">long</span> instanceId, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> </div>
|
|
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#abaf932f3e71631084624d746884d03cf"> 215</a></span> ValueTask <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#abaf932f3e71631084624d746884d03cf">Delete<TBody></a>(<span class="keywordtype">string</span> route, TBody body, <span class="keywordtype">long</span> instanceId, CancellationToken cancellationToken)</div>
|
|
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> where TBody : <span class="keyword">class</span>;</div>
|
|
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> </div>
|
|
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a70558da5b5295944f8e04a128fd9762b">Delete<TResult></a>(<span class="keywordtype">string</span> route, <span class="keywordtype">long</span> instanceId, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> </div>
|
|
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> ValueTask<TResult> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a741248ce21b8e52e1e438d43004b0b3d">Delete<TBody, TResult></a>(<span class="keywordtype">string</span> route, TBody body, <span class="keywordtype">long</span> instanceId, CancellationToken cancellationToken)</div>
|
|
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> where TBody : <span class="keyword">class</span>;</div>
|
|
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span>}</div>
|
|
<div class="ttc" id="aclass_i_async_disposable_html"><div class="ttname"><a href="class_i_async_disposable.html">IAsyncDisposable</a></div></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="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_a0520e3f39c179638f3d7b50ae248ef7d"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a0520e3f39c179638f3d7b50ae248ef7d">Tgstation.Server.Client.IApiClient.Create< TBody, TResult ></a></div><div class="ttdeci">ValueTask< TResult > Create< TBody, TResult >(string route, TBody body, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP PUT request.</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_a1d7641b8a35e5ff8e2ab72db7e4d52c0"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a1d7641b8a35e5ff8e2ab72db7e4d52c0">Tgstation.Server.Client.IApiClient.CreateHubConnection< THubImplementation ></a></div><div class="ttdeci">ValueTask< IAsyncDisposable > CreateHubConnection< THubImplementation >(THubImplementation hubImplementation, IRetryPolicy? retryPolicy, Action< ILoggingBuilder >? loggingConfigureAction, CancellationToken cancellationToken)</div><div class="ttdoc">Subscribe to all job updates available to the IRestServerClient.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a213b113fb0bcf8056fdc52dcfdce239c"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a213b113fb0bcf8056fdc52dcfdce239c">Tgstation.Server.Client.IApiClient.Update< TBody ></a></div><div class="ttdeci">ValueTask Update< TBody >(string route, TBody body, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP POST request.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a271d7164da269f3c130c6275febae935"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a271d7164da269f3c130c6275febae935">Tgstation.Server.Client.IApiClient.Update< TResult ></a></div><div class="ttdeci">ValueTask< TResult > Update< TResult >(string route, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP POST request.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a3e243ce6c09deb68c28dccd05a8d50ca"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a3e243ce6c09deb68c28dccd05a8d50ca">Tgstation.Server.Client.IApiClient.Patch</a></div><div class="ttdeci">ValueTask Patch(string route, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP PATCH request.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a482fc5929a49142b76dd5370e96c526e"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a482fc5929a49142b76dd5370e96c526e">Tgstation.Server.Client.IApiClient.Create< TResult ></a></div><div class="ttdeci">ValueTask< TResult > Create< TResult >(string route, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP PUT request.</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_a6120f26a5fd0cf6319b11d4249296b47"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a6120f26a5fd0cf6319b11d4249296b47">Tgstation.Server.Client.IApiClient.Delete</a></div><div class="ttdeci">ValueTask Delete(string route, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP DELETE request.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a6c9dbcbf335c17714d4450a73698c92c"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a6c9dbcbf335c17714d4450a73698c92c">Tgstation.Server.Client.IApiClient.Patch< TResult ></a></div><div class="ttdeci">ValueTask< TResult > Patch< TResult >(string route, long instanceId, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP PATCH request.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a70558da5b5295944f8e04a128fd9762b"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a70558da5b5295944f8e04a128fd9762b">Tgstation.Server.Client.IApiClient.Delete< TResult ></a></div><div class="ttdeci">ValueTask< TResult > Delete< TResult >(string route, long instanceId, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP DELETE request.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a741248ce21b8e52e1e438d43004b0b3d"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a741248ce21b8e52e1e438d43004b0b3d">Tgstation.Server.Client.IApiClient.Delete< TBody, TResult ></a></div><div class="ttdeci">ValueTask< TResult > Delete< TBody, TResult >(string route, TBody body, long instanceId, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP DELETE request.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_a8dd4bcc45d323460eda585f3b2304607"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#a8dd4bcc45d323460eda585f3b2304607">Tgstation.Server.Client.IApiClient.Read< TResult ></a></div><div class="ttdeci">ValueTask< TResult > Read< TResult >(string route, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP GET request.</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_abaf932f3e71631084624d746884d03cf"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#abaf932f3e71631084624d746884d03cf">Tgstation.Server.Client.IApiClient.Delete< TBody ></a></div><div class="ttdeci">ValueTask Delete< TBody >(string route, TBody body, long instanceId, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP DELETE request.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_abf63ca32d7f8c2f1eab46175aade045b"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#abf63ca32d7f8c2f1eab46175aade045b">Tgstation.Server.Client.IApiClient.Delete</a></div><div class="ttdeci">ValueTask Delete(string route, long instanceId, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP DELETE request.</div></div>
|
|
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_html_accf90de7f179b289eab1476386942c13"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html#accf90de7f179b289eab1476386942c13">Tgstation.Server.Client.IApiClient.Update< TBody, TResult ></a></div><div class="ttdeci">ValueTask< TResult > Update< TBody, TResult >(string route, TBody body, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP POST request.</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_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_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="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_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 <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>
|