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

153 lines
18 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.Host/GraphQL/Mutation.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_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_26e902284bbadb812716475690544a7b.html">GraphQL</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Mutation.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_mutation_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>HotChocolate;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>HotChocolate.Authorization;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">using </span>HotChocolate.Types;</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">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_authority.html">Tgstation.Server.Host.Authority</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_host_1_1_graph_q_l_1_1_mutations_1_1_payloads.html">Tgstation.Server.Host.GraphQL.Mutations.Payloads</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_host_1_1_graph_q_l.html">Tgstation.Server.Host.GraphQL</a></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>{</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> [Authorize]</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> [GraphQLDescription(GraphQLDescription)]</div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html"> 20</a></span> <span class="keyword">public</span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html">Mutation</a></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html#a16e70cc44f5bbfdf79b4966cf1839bab"> 25</a></span> <span class="keyword">public</span> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html#a16e70cc44f5bbfdf79b4966cf1839bab">GraphQLDescription</a> = <span class="stringliteral">&quot;Root Mutation type&quot;</span>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> [AllowAnonymous]</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> [Error(typeof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_error_message_exception.html">ErrorMessageException</a>))]</div>
<div class="foldopen" id="foldopen00035" data-start="{" data-end="}">
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html#ad3623e4f91886fbb2a7097e52501f0f7"> 35</a></span> <span class="keyword">public</span> ValueTask&lt;LoginResult&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html#ad3623e4f91886fbb2a7097e52501f0f7">Login</a>(</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> [Service] <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_graph_q_l_authority_invoker.html">IGraphQLAuthorityInvoker&lt;ILoginAuthority&gt;</a> loginAuthority,</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> CancellationToken cancellationToken)</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> ArgumentNullException.ThrowIfNull(loginAuthority);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">return</span> loginAuthority.Invoke&lt;<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads_1_1_login_result.html">LoginResult</a>, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads_1_1_login_result.html">LoginResult</a>&gt;(</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> authority =&gt; authority.AttemptLogin(cancellationToken));</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> [AllowAnonymous]</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> [Error(typeof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_error_message_exception.html">ErrorMessageException</a>))]</div>
<div class="foldopen" id="foldopen00053" data-start="{" data-end="}">
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html#ac59a3515dbee0e77de827f2fafd7b688"> 53</a></span> <span class="keyword">public</span> ValueTask&lt;OAuthGatewayLoginResult&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html#ac59a3515dbee0e77de827f2fafd7b688">OAuthGateway</a>(</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> [Service] <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_graph_q_l_authority_invoker.html">IGraphQLAuthorityInvoker&lt;ILoginAuthority&gt;</a> loginAuthority,</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> CancellationToken cancellationToken)</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> {</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> ArgumentNullException.ThrowIfNull(loginAuthority);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">return</span> loginAuthority.Invoke&lt;<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads_1_1_o_auth_gateway_login_result.html">OAuthGatewayLoginResult</a>, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads_1_1_o_auth_gateway_login_result.html">OAuthGatewayLoginResult</a>&gt;(</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> authority =&gt; authority.AttemptOAuthGatewayLogin(cancellationToken));</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> }</div>
</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_error_message_exception_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_error_message_exception.html">Tgstation.Server.Host.GraphQL.ErrorMessageException</a></div><div class="ttdoc">Exception representing ErrorMessageResponses.</div><div class="ttdef"><b>Definition</b> <a href="_error_message_exception_8cs_source.html#l00013">ErrorMessageException.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html">Tgstation.Server.Host.GraphQL.Mutation</a></div><div class="ttdoc">Root type for GraphQL mutations.</div><div class="ttdef"><b>Definition</b> <a href="_mutation_8cs_source.html#l00020">Mutation.cs:21</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation_html_a16e70cc44f5bbfdf79b4966cf1839bab"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html#a16e70cc44f5bbfdf79b4966cf1839bab">Tgstation.Server.Host.GraphQL.Mutation.GraphQLDescription</a></div><div class="ttdeci">const string GraphQLDescription</div><div class="ttdoc">Description to show on the Mutation type.</div><div class="ttdef"><b>Definition</b> <a href="_mutation_8cs_source.html#l00025">Mutation.cs:25</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation_html_ac59a3515dbee0e77de827f2fafd7b688"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html#ac59a3515dbee0e77de827f2fafd7b688">Tgstation.Server.Host.GraphQL.Mutation.OAuthGateway</a></div><div class="ttdeci">ValueTask&lt; OAuthGatewayLoginResult &gt; OAuthGateway([Service] IGraphQLAuthorityInvoker&lt; ILoginAuthority &gt; loginAuthority, CancellationToken cancellationToken)</div><div class="ttdoc">Generate an OAuth user token for the requested service. This requires the OAuth authentication scheme...</div><div class="ttdef"><b>Definition</b> <a href="_mutation_8cs_source.html#l00053">Mutation.cs:53</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation_html_ad3623e4f91886fbb2a7097e52501f0f7"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation.html#ad3623e4f91886fbb2a7097e52501f0f7">Tgstation.Server.Host.GraphQL.Mutation.Login</a></div><div class="ttdeci">ValueTask&lt; LoginResult &gt; Login([Service] IGraphQLAuthorityInvoker&lt; ILoginAuthority &gt; loginAuthority, CancellationToken cancellationToken)</div><div class="ttdoc">Generate a JWT for authenticating with server. This requires either the Basic authentication or OAuth...</div><div class="ttdef"><b>Definition</b> <a href="_mutation_8cs_source.html#l00035">Mutation.cs:35</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads_1_1_login_result_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads_1_1_login_result.html">Tgstation.Server.Host.GraphQL.Mutations.Payloads.LoginResult</a></div><div class="ttdoc">Success response for a login attempt.</div><div class="ttdef"><b>Definition</b> <a href="_login_result_8cs_source.html#l00011">LoginResult.cs:12</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads_1_1_o_auth_gateway_login_result_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads_1_1_o_auth_gateway_login_result.html">Tgstation.Server.Host.GraphQL.Mutations.Payloads.OAuthGatewayLoginResult</a></div><div class="ttdoc">Success result for an OAuth gateway login attempt.</div><div class="ttdef"><b>Definition</b> <a href="_o_auth_gateway_login_result_8cs_source.html#l00011">OAuthGatewayLoginResult.cs:12</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_graph_q_l_authority_invoker_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_graph_q_l_authority_invoker.html">Tgstation.Server.Host.Authority.IGraphQLAuthorityInvoker</a></div><div class="ttdoc">Invokes TAuthority s from GraphQL endpoints.</div><div class="ttdef"><b>Definition</b> <a href="_i_graph_q_l_authority_invoker_02_t_authority_03_8cs_source.html#l00020">IGraphQLAuthorityInvoker{TAuthority}.cs:22</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_authority_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_authority.html">Tgstation.Server.Host.Authority</a></div><div class="ttdef"><b>Definition</b> <a href="_administration_authority_8cs_source.html#l00025">AdministrationAuthority.cs:26</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads.html">Tgstation.Server.Host.GraphQL.Mutations.Payloads</a></div><div class="ttdef"><b>Definition</b> <a href="_login_result_8cs_source.html#l00006">LoginResult.cs:7</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l.html">Tgstation.Server.Host.GraphQL</a></div><div class="ttdef"><b>Definition</b> <a href="_authorization_helper_8cs_source.html#l00013">AuthorizationHelper.cs:14</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