mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-24 21:46:52 +01:00
137 lines
13 KiB
HTML
137 lines
13 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/ApiClientFactory.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">ApiClientFactory.cs</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_api_client_factory_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.Net.Http;</div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</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="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</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="l00007" name="l00007"></a><span class="lineno"> 7</span>{</div>
|
|
<div class="foldopen" id="foldopen00009" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_api_client_factory.html"> 9</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_api_client_factory.html">ApiClientFactory</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client_factory.html">IApiClientFactory</a></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> {</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_api_client_factory.html#aca41a822cce8517c0ccec8cf409555cd"> 12</a></span> <span class="keyword">public</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_function" href="class_tgstation_1_1_server_1_1_client_1_1_api_client_factory.html#aca41a822cce8517c0ccec8cf409555cd">CreateApiClient</a>(</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> Uri url,</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a> apiHeaders,</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>? tokenRefreshHeaders,</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keywordtype">bool</span> authless) => <span class="keyword">new</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>(</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">new</span> HttpClient(),</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> url,</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> apiHeaders,</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> tokenRefreshHeaders,</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> authless);</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_api_client_factory.html#af6c19db8ec6f9583463dc6c898951805"> 24</a></span> <span class="keyword">public</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_function" href="class_tgstation_1_1_server_1_1_client_1_1_api_client_factory.html#af6c19db8ec6f9583463dc6c898951805">CreateApiClient</a>(</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> Uri url,</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a> apiHeaders,</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>? tokenRefreshHeaders,</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> HttpMessageHandler handler,</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">bool</span> disposeHandler,</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">bool</span> authless) => <span class="keyword">new</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>(</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">new</span> HttpClient(handler, disposeHandler),</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> url,</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> apiHeaders,</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> tokenRefreshHeaders,</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> authless);</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span>}</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_client_1_1_api_client_factory_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_api_client_factory.html">Tgstation.Server.Client.ApiClientFactory</a></div><div class="ttdef"><b>Definition</b> <a href="_api_client_factory_8cs_source.html#l00009">ApiClientFactory.cs:10</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_api_client_factory_html_aca41a822cce8517c0ccec8cf409555cd"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_api_client_factory.html#aca41a822cce8517c0ccec8cf409555cd">Tgstation.Server.Client.ApiClientFactory.CreateApiClient</a></div><div class="ttdeci">IApiClient CreateApiClient(Uri url, ApiHeaders apiHeaders, ApiHeaders? tokenRefreshHeaders, bool authless)</div><div class="ttdoc">Create an IApiClient.A new IApiClient.</div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_api_client_factory_html_af6c19db8ec6f9583463dc6c898951805"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_api_client_factory.html#af6c19db8ec6f9583463dc6c898951805">Tgstation.Server.Client.ApiClientFactory.CreateApiClient</a></div><div class="ttdeci">IApiClient CreateApiClient(Uri url, ApiHeaders apiHeaders, ApiHeaders? tokenRefreshHeaders, HttpMessageHandler handler, bool disposeHandler, bool authless)</div><div class="ttdoc">Create an IApiClient.A new IApiClient.</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="ainterface_tgstation_1_1_server_1_1_client_1_1_i_api_client_factory_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client_factory.html">Tgstation.Server.Client.IApiClientFactory</a></div><div class="ttdoc">For creating IApiClients.</div><div class="ttdef"><b>Definition</b> <a href="_i_api_client_factory_8cs_source.html#l00011">IApiClientFactory.cs:12</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_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>
|