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

179 lines
39 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/InstanceManagerClient.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">InstanceManagerClient.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_instance_manager_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><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_client_1_1_components.html">Tgstation.Server.Client.Components</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_client.html">Tgstation.Server.Client</a></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>{</div>
<div class="foldopen" id="foldopen00015" data-start="{" data-end="};">
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html"> 15</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_instance_manager_client.html">InstanceManagerClient</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_instance_manager_client.html">IInstanceManagerClient</a></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {</div>
<div class="foldopen" id="foldopen00021" data-start="{" data-end="}">
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a2d6043c1548bc86551fe56f12a78d4cb"> 21</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a2d6043c1548bc86551fe56f12a78d4cb">InstanceManagerClient</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="l00022" name="l00022"></a><span class="lineno"> 22</span> : <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">base</a>(apiClient)</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> }</div>
</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a039363171f5da1ef2605d31e82dbfc1b"> 27</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ValueTask&lt;InstanceResponse&gt;</a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a039363171f5da1ef2605d31e82dbfc1b">CreateOrAttach</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_instance_create_request.html">InstanceCreateRequest</a> instance, <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">CancellationToken</a> cancellationToken) =&gt; <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.Create&lt;<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_instance_create_request.html">InstanceCreateRequest</a>, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_instance_response.html">InstanceResponse</a>&gt;(<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#a17bfc22b8cbc4624a6ec180aeba91da8">InstanceManager</a>, instance ?? <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_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ArgumentNullException</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">nameof</a>(instance)), cancellationToken);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a3f061eb484143f41cef1aef9d85ff28a"> 30</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ValueTask</a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a3f061eb484143f41cef1aef9d85ff28a">Detach</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> instance, <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">CancellationToken</a> cancellationToken) =&gt; <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html#a3db5ef824b0f9492d416bc1fdd8b1984">Delete</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#a17bfc22b8cbc4624a6ec180aeba91da8">InstanceManager</a>, instance?.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_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ArgumentNullException</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">nameof</a>(instance))), cancellationToken);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab"> 33</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ValueTask&lt;List&lt;InstanceResponse&gt;</a>&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">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_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">paginationSettings</a>, <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">CancellationToken</a> cancellationToken)</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> =&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ReadPaged&lt;InstanceResponse&gt;</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">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#a17bfc22b8cbc4624a6ec180aeba91da8">InstanceManager</a>), <span class="keyword">null</span>, cancellationToken);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a55d7e35774b8520798b62a9c5dc5be56"> 37</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ValueTask&lt;InstanceResponse&gt;</a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a0c0cd8a0381d0a3c7105c3d585545738">Update</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_instance_update_request.html">InstanceUpdateRequest</a> instance, <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">CancellationToken</a> cancellationToken) =&gt; <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.Update&lt;<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_instance_update_request.html">InstanceUpdateRequest</a>, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_instance_response.html">InstanceResponse</a>&gt;(<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#a17bfc22b8cbc4624a6ec180aeba91da8">InstanceManager</a>, instance ?? <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_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ArgumentNullException</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">nameof</a>(instance)), cancellationToken);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a0ecb0587a4961d80d4338f83c4a7304f"> 40</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ValueTask&lt;InstanceResponse&gt;</a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a0ecb0587a4961d80d4338f83c4a7304f">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> instance, <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">CancellationToken</a> cancellationToken) =&gt; <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.Read&lt;<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_instance_response.html">InstanceResponse</a>&gt;(<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#a17bfc22b8cbc4624a6ec180aeba91da8">InstanceManager</a>, instance?.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_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ArgumentNullException</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">nameof</a>(instance))), cancellationToken);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a0b00e9b9eac57142fa2ddbdbd4bd8092"> 43</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ValueTask</a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a0b00e9b9eac57142fa2ddbdbd4bd8092">GrantPermissions</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> instance, <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">CancellationToken</a> cancellationToken) =&gt; <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html">ApiClient</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html#a6d2c42aace1b3bf8e2e542c4c210aec9">Patch</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#a17bfc22b8cbc4624a6ec180aeba91da8">InstanceManager</a>, instance?.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_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ArgumentNullException</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">nameof</a>(instance))), cancellationToken);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="foldopen" id="foldopen00046" data-start="{" data-end="}">
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#aad7c5289f672bb2598084276d583a1f9"> 46</a></span> <span class="keyword">public</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_client_1_1_components_1_1_i_instance_client.html">IInstanceClient</a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#aad7c5289f672bb2598084276d583a1f9">CreateClient</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_instance.html">Instance</a> instance)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">if</span> (instance == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <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_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ArgumentNullException</a>(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">nameof</a>(instance));</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">if</span> (!instance.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html#ae31e478e1d338b37a14565df6fd58570">Id</a>.HasValue)</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <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_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">ArgumentException</a>(<span class="stringliteral">&quot;Instance missing Id!&quot;</span>, <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">nameof</a>(instance));</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_instance_client.html">InstanceClient</a>(</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</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="l00056" name="l00056"></a><span class="lineno"> 56</span> instance);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> }</div>
</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> }</div>
</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</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_entity_id_html_ae31e478e1d338b37a14565df6fd58570"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html#ae31e478e1d338b37a14565df6fd58570">Tgstation.Server.Api.Models.EntityId.Id</a></div><div class="ttdeci">virtual ? long Id</div><div class="ttdoc">The ID of the entity.</div><div class="ttdef"><b>Definition</b> <a href="_entity_id_8cs_source.html#l00014">EntityId.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_instance_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_instance.html">Tgstation.Server.Api.Models.Instance</a></div><div class="ttdoc">Metadata about a server instance.</div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_instance_8cs_source.html#l00008">Instance.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_instance_create_request_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_instance_create_request.html">Tgstation.Server.Api.Models.Request.InstanceCreateRequest</a></div><div class="ttdoc">A request to create an Instance.</div><div class="ttdef"><b>Definition</b> <a href="_instance_create_request_8cs_source.html#l00006">InstanceCreateRequest.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_instance_update_request_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_instance_update_request.html">Tgstation.Server.Api.Models.Request.InstanceUpdateRequest</a></div><div class="ttdoc">A request to update an Instance.</div><div class="ttdef"><b>Definition</b> <a href="_instance_update_request_8cs_source.html#l00006">InstanceUpdateRequest.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_instance_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_instance_response.html">Tgstation.Server.Api.Models.Response.InstanceResponse</a></div><div class="ttdoc">Server response for Instances.</div><div class="ttdef"><b>Definition</b> <a href="_instance_response_8cs_source.html#l00006">InstanceResponse.cs:7</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_a17bfc22b8cbc4624a6ec180aeba91da8"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_routes.html#a17bfc22b8cbc4624a6ec180aeba91da8">Tgstation.Server.Api.Routes.InstanceManager</a></div><div class="ttdeci">const string InstanceManager</div><div class="ttdoc">The Models.Instance controller.</div><div class="ttdef"><b>Definition</b> <a href="_routes_8cs_source.html#l00048">Routes.cs:48</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_api_client_html_a3db5ef824b0f9492d416bc1fdd8b1984"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html#a3db5ef824b0f9492d416bc1fdd8b1984">Tgstation.Server.Client.ApiClient.Delete</a></div><div class="ttdeci">ValueTask Delete(string route, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP DELETE request.A ValueTask representing the running operation.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_api_client_html_a6d2c42aace1b3bf8e2e542c4c210aec9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_api_client.html#a6d2c42aace1b3bf8e2e542c4c210aec9">Tgstation.Server.Client.ApiClient.Patch</a></div><div class="ttdeci">ValueTask Patch(string route, CancellationToken cancellationToken)</div><div class="ttdoc">Run an HTTP PATCH request.A ValueTask representing the running operation.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_components_1_1_instance_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_components_1_1_instance_client.html">Tgstation.Server.Client.Components.InstanceClient</a></div><div class="ttdef"><b>Definition</b> <a href="_instance_client_8cs_source.html#l00008">InstanceClient.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_instance_manager_client_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html">Tgstation.Server.Client.InstanceManagerClient</a></div><div class="ttdef"><b>Definition</b> <a href="_instance_manager_client_8cs_source.html#l00015">InstanceManagerClient.cs:16</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_instance_manager_client_html_a039363171f5da1ef2605d31e82dbfc1b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a039363171f5da1ef2605d31e82dbfc1b">Tgstation.Server.Client.InstanceManagerClient.CreateOrAttach</a></div><div class="ttdeci">ValueTask&lt; InstanceResponse &gt; CreateOrAttach(InstanceCreateRequest instance, CancellationToken cancellationToken)</div><div class="ttdoc">Create or attach an instance .A ValueTask&lt;TResult&gt; resulting in the created or attached Instance.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_instance_manager_client_html_a0b00e9b9eac57142fa2ddbdbd4bd8092"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a0b00e9b9eac57142fa2ddbdbd4bd8092">Tgstation.Server.Client.InstanceManagerClient.GrantPermissions</a></div><div class="ttdeci">ValueTask GrantPermissions(EntityId instance, CancellationToken cancellationToken)</div><div class="ttdoc">Gives the user full permissions on an instance .A ValueTask representing the running operation.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_instance_manager_client_html_a0c0cd8a0381d0a3c7105c3d585545738"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a0c0cd8a0381d0a3c7105c3d585545738">Tgstation.Server.Client.InstanceManagerClient.Update</a></div><div class="ttdeci">ValueTask&lt; InstanceResponse &gt; Update(InstanceUpdateRequest instance, CancellationToken cancellationToken)</div><div class="ttdoc">Relocates, renamed, and/or on/offlines an instance .A ValueTask&lt;TResult&gt; resulting in the updated Ins...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_instance_manager_client_html_a0ecb0587a4961d80d4338f83c4a7304f"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a0ecb0587a4961d80d4338f83c4a7304f">Tgstation.Server.Client.InstanceManagerClient.GetId</a></div><div class="ttdeci">ValueTask&lt; InstanceResponse &gt; GetId(EntityId instance, CancellationToken cancellationToken)</div><div class="ttdoc">Get a specific instance .A ValueTask&lt;TResult&gt; resulting in the Instance.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_instance_manager_client_html_a2d6043c1548bc86551fe56f12a78d4cb"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a2d6043c1548bc86551fe56f12a78d4cb">Tgstation.Server.Client.InstanceManagerClient.InstanceManagerClient</a></div><div class="ttdeci">InstanceManagerClient(IApiClient apiClient)</div><div class="ttdoc">Initializes a new instance of the InstanceManagerClient class.</div><div class="ttdef"><b>Definition</b> <a href="_instance_manager_client_8cs_source.html#l00021">InstanceManagerClient.cs:21</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_instance_manager_client_html_a3f061eb484143f41cef1aef9d85ff28a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a3f061eb484143f41cef1aef9d85ff28a">Tgstation.Server.Client.InstanceManagerClient.Detach</a></div><div class="ttdeci">ValueTask Detach(EntityId instance, CancellationToken cancellationToken)</div><div class="ttdoc">Deletes an instance .A ValueTask representing the running operation.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_instance_manager_client_html_a4ea5f47f88e69cca85a566095e8c9fab"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#a4ea5f47f88e69cca85a566095e8c9fab">Tgstation.Server.Client.InstanceManagerClient.List</a></div><div class="ttdeci">ValueTask&lt; List&lt; InstanceResponse &gt; &gt; List(PaginationSettings? paginationSettings, CancellationToken cancellationToken)</div><div class="ttdoc">Get all IInstanceClients for Instances the user can view.A ValueTask&lt;TResult&gt; resulting in a List&lt;T&gt; ...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_instance_manager_client_html_aad7c5289f672bb2598084276d583a1f9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html#aad7c5289f672bb2598084276d583a1f9">Tgstation.Server.Client.InstanceManagerClient.CreateClient</a></div><div class="ttdeci">IInstanceClient CreateClient(Instance instance)</div><div class="ttdoc">Create an IInstanceClient for a given Instance.A new IInstanceClient.</div><div class="ttdef"><b>Definition</b> <a href="_instance_manager_client_8cs_source.html#l00046">InstanceManagerClient.cs:46</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="ainterface_tgstation_1_1_server_1_1_client_1_1_components_1_1_i_instance_client_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_components_1_1_i_instance_client.html">Tgstation.Server.Client.Components.IInstanceClient</a></div><div class="ttdoc">For managing a single Instance.</div><div class="ttdef"><b>Definition</b> <a href="_i_instance_client_8cs_source.html#l00008">IInstanceClient.cs:9</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="ainterface_tgstation_1_1_server_1_1_client_1_1_i_instance_manager_client_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_client_1_1_i_instance_manager_client.html">Tgstation.Server.Client.IInstanceManagerClient</a></div><div class="ttdoc">For managing Instances.</div><div class="ttdef"><b>Definition</b> <a href="_i_instance_manager_client_8cs_source.html#l00015">IInstanceManagerClient.cs:16</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_1_1_components_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_client_1_1_components.html">Tgstation.Server.Client.Components</a></div><div class="ttdef"><b>Definition</b> <a href="_chat_bots_client_8cs_source.html#l00011">ChatBotsClient.cs:12</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