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

145 lines
17 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/IRestServerClientFactory.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">IRestServerClientFactory.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_rest_server_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.Collections.Generic;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Threading;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>System.Threading.Tasks;</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">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="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_1_1_models_1_1_response.html">Tgstation.Server.Api.Models.Response</a>;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</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="l00010" name="l00010"></a><span class="lineno"> 10</span>{</div>
<div class="foldopen" id="foldopen00014" data-start="{" data-end="};">
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html"> 14</a></span> <span class="keyword">public</span> <span class="keyword">interface </span><a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html">IRestServerClientFactory</a></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#ad48c5ff493b1135ccc0407f2f9d651d6"> 24</a></span> ValueTask&lt;ServerInformationResponse&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#ad48c5ff493b1135ccc0407f2f9d651d6">GetServerInformation</a>(</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> Uri host,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> IEnumerable&lt;IRequestLogger&gt;? requestLoggers = <span class="keyword">null</span>,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> TimeSpan? timeout = <span class="keyword">null</span>,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> CancellationToken cancellationToken = <span class="keywordflow">default</span>);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#a539c44c4822d23e733aca8b8106d5169"> 41</a></span> ValueTask&lt;IRestServerClient&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#a539c44c4822d23e733aca8b8106d5169">CreateFromLogin</a>(</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> Uri host,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">string</span> username,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">string</span> password,</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> IEnumerable&lt;IRequestLogger&gt;? requestLoggers = <span class="keyword">null</span>,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> TimeSpan? timeout = <span class="keyword">null</span>,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">bool</span> attemptLoginRefresh = <span class="keyword">true</span>,</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> CancellationToken cancellationToken = <span class="keywordflow">default</span>);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#a10b13c71550996ca59b3e77945e2c8b2"> 60</a></span> ValueTask&lt;IRestServerClient&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#a10b13c71550996ca59b3e77945e2c8b2">CreateFromOAuth</a>(</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> Uri host,</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">string</span> oAuthCode,</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a49b1c1275c0d47d43360f8c7619ec901">OAuthProvider</a> oAuthProvider,</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> IEnumerable&lt;IRequestLogger&gt;? requestLoggers = <span class="keyword">null</span>,</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> TimeSpan? timeout = <span class="keyword">null</span>,</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> CancellationToken cancellationToken = <span class="keywordflow">default</span>);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#ab11454a2ac44dd669bb7d6a7c3855201"> 74</a></span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client.html">IRestServerClient</a> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#ab11454a2ac44dd669bb7d6a7c3855201">CreateFromToken</a>(</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> Uri host,</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</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> token);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> }</div>
</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>}</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="ainterface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html">Tgstation.Server.Client.IRestServerClientFactory</a></div><div class="ttdoc">Factory for creating IRestServerClients.</div><div class="ttdef"><b>Definition</b> <a href="_i_rest_server_client_factory_8cs_source.html#l00014">IRestServerClientFactory.cs:15</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory_html_a10b13c71550996ca59b3e77945e2c8b2"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#a10b13c71550996ca59b3e77945e2c8b2">Tgstation.Server.Client.IRestServerClientFactory.CreateFromOAuth</a></div><div class="ttdeci">ValueTask&lt; IRestServerClient &gt; CreateFromOAuth(Uri host, string oAuthCode, OAuthProvider oAuthProvider, IEnumerable&lt; IRequestLogger &gt;? requestLoggers=null, TimeSpan? timeout=null, CancellationToken cancellationToken=default)</div><div class="ttdoc">Create a IRestServerClient using an OAuth login.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory_html_a539c44c4822d23e733aca8b8106d5169"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#a539c44c4822d23e733aca8b8106d5169">Tgstation.Server.Client.IRestServerClientFactory.CreateFromLogin</a></div><div class="ttdeci">ValueTask&lt; IRestServerClient &gt; CreateFromLogin(Uri host, string username, string password, IEnumerable&lt; IRequestLogger &gt;? requestLoggers=null, TimeSpan? timeout=null, bool attemptLoginRefresh=true, CancellationToken cancellationToken=default)</div><div class="ttdoc">Create a IRestServerClient using a password login.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory_html_ab11454a2ac44dd669bb7d6a7c3855201"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#ab11454a2ac44dd669bb7d6a7c3855201">Tgstation.Server.Client.IRestServerClientFactory.CreateFromToken</a></div><div class="ttdeci">IRestServerClient CreateFromToken(Uri host, TokenResponse token)</div><div class="ttdoc">Create a IRestServerClient.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory_html_ad48c5ff493b1135ccc0407f2f9d651d6"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_rest_server_client_factory.html#ad48c5ff493b1135ccc0407f2f9d651d6">Tgstation.Server.Client.IRestServerClientFactory.GetServerInformation</a></div><div class="ttdeci">ValueTask&lt; ServerInformationResponse &gt; GetServerInformation(Uri host, IEnumerable&lt; IRequestLogger &gt;? requestLoggers=null, TimeSpan? timeout=null, CancellationToken cancellationToken=default)</div><div class="ttdoc">Gets the ServerInformationResponse for a given host .</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="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_1_1_models_html_a49b1c1275c0d47d43360f8c7619ec901"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a49b1c1275c0d47d43360f8c7619ec901">Tgstation.Server.Api.Models.OAuthProvider</a></div><div class="ttdeci">OAuthProvider</div><div class="ttdoc">List of OAuth2.0 providers supported by TGS that do not support OIDC.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_provider_8cs_source.html#l00012">OAuthProvider.cs:13</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