mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-24 21:46:52 +01:00
152 lines
27 KiB
HTML
152 lines
27 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/UsersClient.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">UsersClient.cs</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_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;</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.html">Tgstation.Server.Api</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.html">Tgstation.Server.Api.Models</a>;</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_1_1_models_1_1_request.html">Tgstation.Server.Api.Models.Request</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_1_1_response.html">Tgstation.Server.Api.Models.Response</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="foldopen00014" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html"> 14</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_users_client.html">UsersClient</a> : <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_paginated_client.html">PaginatedClient</a>, <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="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_client_1_1_users_client.html#aa7e771fad86b68de8483944e9f34a88e"> 20</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#aa7e771fad86b68de8483944e9f34a88e">UsersClient</a>(<a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_i_api_client.html">IApiClient</a> apiClient)</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> : <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">base</a>(apiClient)</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> {</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#aebef62eb3d5b103572da6a1b02061149"> 26</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">ValueTask<UserResponse></a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#aebef62eb3d5b103572da6a1b02061149">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="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">CancellationToken</a> cancellationToken) => <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.Create<<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>, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_user_response.html">UserResponse</a>>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a12784e8b5b7ac25c0684c9d4c7c59178">User</a>, user ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">ArgumentNullException</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">nameof</a>(user)), cancellationToken);</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#acffaa8f9b07ced00f31802b8c3635759"> 29</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">ValueTask<UserResponse></a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#acffaa8f9b07ced00f31802b8c3635759">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="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">CancellationToken</a> cancellationToken) => <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.Read<<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_user_response.html">UserResponse</a>>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a0266a146dbc57a7c6168533d7a7b10eb">SetID</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a12784e8b5b7ac25c0684c9d4c7c59178">User</a>, user?.Id ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">ArgumentNullException</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">nameof</a>(user))), cancellationToken);</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600"> 32</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">ValueTask<List<UserResponse></a>> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">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="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">paginationSettings</a>, <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">CancellationToken</a> cancellationToken)</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> => <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">ReadPaged<UserResponse></a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">paginationSettings</a>, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a21a829d350fad918024f30fc9330a8e2">ListRoute</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a12784e8b5b7ac25c0684c9d4c7c59178">User</a>), <span class="keyword">null</span>, cancellationToken);</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ac5d6328301eb94247bd3fedb0d111c92"> 36</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">ValueTask<UserResponse></a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ac5d6328301eb94247bd3fedb0d111c92">Read</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">CancellationToken</a> cancellationToken) => <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.Read<<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_user_response.html">UserResponse</a>>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a12784e8b5b7ac25c0684c9d4c7c59178">User</a>, cancellationToken);</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#a22261f516fcea0d17c67293a852ab341"> 39</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">ValueTask<UserResponse></a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#a22261f516fcea0d17c67293a852ab341">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="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">CancellationToken</a> cancellationToken) => <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.Update<<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>, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_user_response.html">UserResponse</a>>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Routes</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a12784e8b5b7ac25c0684c9d4c7c59178">User</a>, user ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">ArgumentNullException</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">nameof</a>(user)), cancellationToken);</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</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_api_1_1_models_1_1_response_1_1_user_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_user_response.html">Tgstation.Server.Api.Models.Response.UserResponse</a></div><div class="ttdef"><b>Definition</b> <a href="_user_response_8cs_source.html#l00008">UserResponse.cs:9</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_routes_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html">Tgstation.Server.Api.Routes</a></div><div class="ttdoc">Routes to a server actions.</div><div class="ttdef"><b>Definition</b> <a href="_routes_8cs_source.html#l00008">Routes.cs:9</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_routes_html_a0266a146dbc57a7c6168533d7a7b10eb"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a0266a146dbc57a7c6168533d7a7b10eb">Tgstation.Server.Api.Routes.SetID</a></div><div class="ttdeci">static string SetID(string route, long id)</div><div class="ttdoc">Apply an id postfix to a route .</div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_routes_html_a12784e8b5b7ac25c0684c9d4c7c59178"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a12784e8b5b7ac25c0684c9d4c7c59178">Tgstation.Server.Api.Routes.User</a></div><div class="ttdeci">const string User</div><div class="ttdoc">The user controller.</div><div class="ttdef"><b>Definition</b> <a href="_routes_8cs_source.html#l00038">Routes.cs:38</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_routes_html_a21a829d350fad918024f30fc9330a8e2"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a21a829d350fad918024f30fc9330a8e2">Tgstation.Server.Api.Routes.ListRoute</a></div><div class="ttdeci">static string ListRoute(string route)</div><div class="ttdoc">Get the /List postfix for a route .</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="aclass_tgstation_1_1_server_1_1_client_1_1_paginated_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_paginated_client.html">Tgstation.Server.Client.PaginatedClient</a></div><div class="ttdoc">Client that deals with getting paginated results.</div><div class="ttdef"><b>Definition</b> <a href="_paginated_client_8cs_source.html#l00016">PaginatedClient.cs:17</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="aclass_tgstation_1_1_server_1_1_client_1_1_users_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html">Tgstation.Server.Client.UsersClient</a></div><div class="ttdef"><b>Definition</b> <a href="_users_client_8cs_source.html#l00014">UsersClient.cs:15</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_users_client_html_a22261f516fcea0d17c67293a852ab341"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#a22261f516fcea0d17c67293a852ab341">Tgstation.Server.Client.UsersClient.Update</a></div><div class="ttdeci">ValueTask< UserResponse > Update(UserUpdateRequest user, CancellationToken cancellationToken)</div><div class="ttdoc">Update a user .A ValueTask<TResult> resulting in the updated UserResponse.</div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_users_client_html_aa7e771fad86b68de8483944e9f34a88e"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#aa7e771fad86b68de8483944e9f34a88e">Tgstation.Server.Client.UsersClient.UsersClient</a></div><div class="ttdeci">UsersClient(IApiClient apiClient)</div><div class="ttdoc">Initializes a new instance of the UsersClient class.</div><div class="ttdef"><b>Definition</b> <a href="_users_client_8cs_source.html#l00020">UsersClient.cs:20</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_users_client_html_ac5d6328301eb94247bd3fedb0d111c92"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ac5d6328301eb94247bd3fedb0d111c92">Tgstation.Server.Client.UsersClient.Read</a></div><div class="ttdeci">ValueTask< UserResponse > Read(CancellationToken cancellationToken)</div><div class="ttdoc">Read the current user's information and general rights.A ValueTask<TResult> resulting in the current ...</div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_users_client_html_acffaa8f9b07ced00f31802b8c3635759"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#acffaa8f9b07ced00f31802b8c3635759">Tgstation.Server.Client.UsersClient.GetId</a></div><div class="ttdeci">ValueTask< UserResponse > GetId(EntityId user, CancellationToken cancellationToken)</div><div class="ttdoc">Get a specific user .A ValueTask<TResult> resulting in the requested user .</div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_users_client_html_ad80177efc7fec8a64b6c523799208600"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#ad80177efc7fec8a64b6c523799208600">Tgstation.Server.Client.UsersClient.List</a></div><div class="ttdeci">ValueTask< List< UserResponse > > List(PaginationSettings? paginationSettings, CancellationToken cancellationToken)</div><div class="ttdoc">List all UserResponses.A ValueTask<TResult> resulting in a List<T> of all UserResponses.</div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_users_client_html_aebef62eb3d5b103572da6a1b02061149"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_users_client.html#aebef62eb3d5b103572da6a1b02061149">Tgstation.Server.Client.UsersClient.Create</a></div><div class="ttdeci">ValueTask< UserResponse > Create(UserCreateRequest user, CancellationToken cancellationToken)</div><div class="ttdoc">Create a new user .A ValueTask<TResult> resulting in the new UserResponse.</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_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="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_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>
|