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_users_client_8cs_source.html
T

131 lines
16 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/IUsersClient.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">IUsersClient.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_users_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.Collections.Generic;</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><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="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_1_1_request.html">Tgstation.Server.Api.Models.Request</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_users_client.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_users_client.html">IUsersClient</a></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</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_users_client.html#a8bfde9cb3ec22b246e95ef43d4ef8843"> 21</a></span> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">ValueTask&lt;UserResponse&gt;</a> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a8bfde9cb3ec22b246e95ef43d4ef8843">Read</a>(<a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">CancellationToken</a> cancellationToken);</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#ae866376d4284cc5aee78c35e4da03d68"> 29</a></span> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">ValueTask&lt;UserResponse&gt;</a> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#ae866376d4284cc5aee78c35e4da03d68">GetId</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html">EntityId</a> user, <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">CancellationToken</a> cancellationToken);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</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_users_client.html#a51f30337e33f0e5a122e4409f465f297"> 37</a></span> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">ValueTask&lt;List&lt;UserResponse&gt;</a>&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">List</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_pagination_settings.html">PaginationSettings</a>? <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">paginationSettings</a>, <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">CancellationToken</a> cancellationToken);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#ab54b6b6b8f41febe43d15e2db1db26af"> 45</a></span> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">ValueTask&lt;UserResponse&gt;</a> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#ab54b6b6b8f41febe43d15e2db1db26af">Create</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_user_create_request.html">UserCreateRequest</a> user, <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">CancellationToken</a> cancellationToken);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a54ac5f1ef23a56c060bb30757f171319"> 53</a></span> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">ValueTask&lt;UserResponse&gt;</a> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a54ac5f1ef23a56c060bb30757f171319">Update</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_user_update_request.html">UserUpdateRequest</a> user, <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">CancellationToken</a> cancellationToken);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> }</div>
</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html">Tgstation.Server.Api.Models.EntityId</a></div><div class="ttdoc">Common base of entities with IDs.</div><div class="ttdef"><b>Definition</b> <a href="_entity_id_8cs_source.html#l00006">EntityId.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_user_create_request_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_user_create_request.html">Tgstation.Server.Api.Models.Request.UserCreateRequest</a></div><div class="ttdoc">For creating a user.</div><div class="ttdef"><b>Definition</b> <a href="_user_create_request_8cs_source.html#l00006">UserCreateRequest.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_user_update_request_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_user_update_request.html">Tgstation.Server.Api.Models.Request.UserUpdateRequest</a></div><div class="ttdoc">For editing a given user.</div><div class="ttdef"><b>Definition</b> <a href="_user_update_request_8cs_source.html#l00010">UserUpdateRequest.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_pagination_settings_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_pagination_settings.html">Tgstation.Server.Client.PaginationSettings</a></div><div class="ttdoc">Settings for a paginated request.</div><div class="ttdef"><b>Definition</b> <a href="_pagination_settings_8cs_source.html#l00006">PaginationSettings.cs:7</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="ainterface_tgstation_1_1_server_1_1_client_1_1_i_users_client_html_a51f30337e33f0e5a122e4409f465f297"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a51f30337e33f0e5a122e4409f465f297">Tgstation.Server.Client.IUsersClient.List</a></div><div class="ttdeci">ValueTask&lt; List&lt; UserResponse &gt; &gt; List(PaginationSettings? paginationSettings, CancellationToken cancellationToken)</div><div class="ttdoc">List all UserResponses.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_users_client_html_a54ac5f1ef23a56c060bb30757f171319"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a54ac5f1ef23a56c060bb30757f171319">Tgstation.Server.Client.IUsersClient.Update</a></div><div class="ttdeci">ValueTask&lt; UserResponse &gt; Update(UserUpdateRequest user, CancellationToken cancellationToken)</div><div class="ttdoc">Update a user .</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_users_client_html_a8bfde9cb3ec22b246e95ef43d4ef8843"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#a8bfde9cb3ec22b246e95ef43d4ef8843">Tgstation.Server.Client.IUsersClient.Read</a></div><div class="ttdeci">ValueTask&lt; UserResponse &gt; Read(CancellationToken cancellationToken)</div><div class="ttdoc">Read the current user's information and general rights.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_users_client_html_ab54b6b6b8f41febe43d15e2db1db26af"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#ab54b6b6b8f41febe43d15e2db1db26af">Tgstation.Server.Client.IUsersClient.Create</a></div><div class="ttdeci">ValueTask&lt; UserResponse &gt; Create(UserCreateRequest user, CancellationToken cancellationToken)</div><div class="ttdoc">Create a new user .</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_client_1_1_i_users_client_html_ae866376d4284cc5aee78c35e4da03d68"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_users_client.html#ae866376d4284cc5aee78c35e4da03d68">Tgstation.Server.Client.IUsersClient.GetId</a></div><div class="ttdeci">ValueTask&lt; UserResponse &gt; GetId(EntityId user, CancellationToken cancellationToken)</div><div class="ttdoc">Get a specific user .</div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_request.html">Tgstation.Server.Api.Models.Request</a></div><div class="ttdef"><b>Definition</b> <a href="_chat_bot_create_request_8cs_source.html#l00003">ChatBotCreateRequest.cs:4</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_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