cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-26 14:37:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Deploy code docs to GitHub Pages for workflow run 1958

Browse Source 
Commit: 01cda70d2e
This commit is contained in:
tgstation-server
2023-12-24 14:11:37 +00:00
parent a348dc233e
commit b0cab53bd0
7067 changed files with 194518 additions and 144547 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_instance_required_controller_8cs_source.html
+33 -22
View File
@@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;5.18.2</span>
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.0.0</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
@@ -88,32 +88,43 @@ $(function() {
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span>{</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html"> 13</a></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html">InstanceRequiredController</a> : <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html">ComponentInterfacingController</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a9d38b9ca4b87794be730d77d3898b51b"> 23</a></span> <span class="keyword">protected</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a9d38b9ca4b87794be730d77d3898b51b">InstanceRequiredController</a>(</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">IDatabaseContext</a> databaseContext,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context.html">IAuthenticationContext</a> authenticationContext,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> ILogger&lt;InstanceRequiredController&gt; logger,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_instance_manager.html">IInstanceManager</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">instanceManager</a>,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_api_headers_provider.html">IApiHeadersProvider</a> apiHeaders)</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> : base(</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> databaseContext,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> authenticationContext,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> logger,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">instanceManager</a>,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> apiHeaders,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> true)</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> }</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>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html">Tgstation.Server.Host.Controllers.ComponentInterfacingController</a></div><div class="ttdoc">ApiController for operations on IInstanceCores.</div><div class="ttdef"><b>Definition:</b> <a href="_component_interfacing_controller_8cs_source.html#l00021">ComponentInterfacingController.cs:22</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller_html_a9a2c4d46ba2467c16b22172a98f1ba35"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">Tgstation.Server.Host.Controllers.ComponentInterfacingController.instanceManager</a></div><div class="ttdeci">readonly IInstanceManager instanceManager</div><div class="ttdoc">The IInstanceManager for the ComponentInterfacingController.</div><div class="ttdef"><b>Definition:</b> <a href="_component_interfacing_controller_8cs_source.html#l00031">ComponentInterfacingController.cs:31</a></div></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a8d54ce2469efc562e7be712137581237"> 18</a></span> <span class="keyword">protected</span> <span class="keyword">new</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_instance.html">Models.Instance</a> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_instance.html">Instance</a> =&gt; base.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_instance.html#a12055ec3d038581c6770e57085adc1db">Instance</a>!;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#acac1e50383cba83566dace0e5fc1496b"> 23</a></span> <span class="keyword">protected</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_instance_permission_set.html">Models.InstancePermissionSet</a> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#acac1e50383cba83566dace0e5fc1496b">InstancePermissionSet</a> =&gt; <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context.html">AuthenticationContext</a>.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context.html#a2414cfa202796c6e1b630baa48e2f800">InstancePermissionSet</a>!;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</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_host_1_1_controllers_1_1_instance_required_controller.html#a9d38b9ca4b87794be730d77d3898b51b"> 33</a></span> <span class="keyword">protected</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a9d38b9ca4b87794be730d77d3898b51b">InstanceRequiredController</a>(</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">IDatabaseContext</a> databaseContext,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context.html">IAuthenticationContext</a> authenticationContext,</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> ILogger&lt;InstanceRequiredController&gt; logger,</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_instance_manager.html">IInstanceManager</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">instanceManager</a>,</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_api_headers_provider.html">IApiHeadersProvider</a> apiHeaders)</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> : base(</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> databaseContext,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> authenticationContext,</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> logger,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">instanceManager</a>,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> apiHeaders,</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> true)</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> {</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> }</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_instance_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_instance.html">Tgstation.Server.Host.Components.Instance</a></div><div class="ttdef"><b>Definition:</b> <a href="_tgstation_8_server_8_host_2_components_2_instance_8cs_source.html#l00028">Instance.cs:29</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_instance_html_a12055ec3d038581c6770e57085adc1db"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_instance.html#a12055ec3d038581c6770e57085adc1db">Tgstation.Server.Host.Components.Instance.Instance</a></div><div class="ttdeci">Instance(Api.Models.Instance metadata, IRepositoryManager repositoryManager, IEngineManager engineManager, IDreamMaker dreamMaker, IWatchdog watchdog, IChatManager chat, StaticFiles.IConfiguration configuration, IDmbFactory dmbFactory, IJobManager jobManager, IEventConsumer eventConsumer, IRemoteDeploymentManagerFactory remoteDeploymentManagerFactory, IAsyncDelayer asyncDelayer, ILogger&lt; Instance &gt; logger)</div><div class="ttdoc">Initializes a new instance of the Instance class.</div><div class="ttdef"><b>Definition:</b> <a href="_tgstation_8_server_8_host_2_components_2_instance_8cs_source.html#l00119">Instance.cs:119</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html">Tgstation.Server.Host.Controllers.ComponentInterfacingController</a></div><div class="ttdoc">ApiController for operations on IInstanceCores.</div><div class="ttdef"><b>Definition:</b> <a href="_component_interfacing_controller_8cs_source.html#l00022">ComponentInterfacingController.cs:23</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller_html_a9a2c4d46ba2467c16b22172a98f1ba35"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">Tgstation.Server.Host.Controllers.ComponentInterfacingController.instanceManager</a></div><div class="ttdeci">readonly IInstanceManager instanceManager</div><div class="ttdoc">The IInstanceManager for the ComponentInterfacingController.</div><div class="ttdef"><b>Definition:</b> <a href="_component_interfacing_controller_8cs_source.html#l00032">ComponentInterfacingController.cs:32</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html">Tgstation.Server.Host.Controllers.InstanceRequiredController</a></div><div class="ttdoc">ComponentInterfacingController for operations that require an instance.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00013">InstanceRequiredController.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html_a9d38b9ca4b87794be730d77d3898b51b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a9d38b9ca4b87794be730d77d3898b51b">Tgstation.Server.Host.Controllers.InstanceRequiredController.InstanceRequiredController</a></div><div class="ttdeci">InstanceRequiredController(IDatabaseContext databaseContext, IAuthenticationContext authenticationContext, ILogger&lt; InstanceRequiredController &gt; logger, IInstanceManager instanceManager, IApiHeadersProvider apiHeaders)</div><div class="ttdoc">Initializes a new instance of the InstanceRequiredController class.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00023">InstanceRequiredController.cs:23</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html_a9d38b9ca4b87794be730d77d3898b51b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a9d38b9ca4b87794be730d77d3898b51b">Tgstation.Server.Host.Controllers.InstanceRequiredController.InstanceRequiredController</a></div><div class="ttdeci">InstanceRequiredController(IDatabaseContext databaseContext, IAuthenticationContext authenticationContext, ILogger&lt; InstanceRequiredController &gt; logger, IInstanceManager instanceManager, IApiHeadersProvider apiHeaders)</div><div class="ttdoc">Initializes a new instance of the InstanceRequiredController class.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00033">InstanceRequiredController.cs:33</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html_acac1e50383cba83566dace0e5fc1496b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#acac1e50383cba83566dace0e5fc1496b">Tgstation.Server.Host.Controllers.InstanceRequiredController.InstancePermissionSet</a></div><div class="ttdeci">Models.InstancePermissionSet InstancePermissionSet</div><div class="ttdoc">The Models.InstancePermissionSet for the request.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00023">InstanceRequiredController.cs:23</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_models_1_1_instance_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_instance.html">Tgstation.Server.Host.Models.Instance</a></div><div class="ttdoc">Represents an Api.Models.Instance in the database.</div><div class="ttdef"><b>Definition:</b> <a href="_tgstation_8_server_8_host_2_models_2_instance_8cs_source.html#l00010">Instance.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_models_1_1_instance_permission_set_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_instance_permission_set.html">Tgstation.Server.Host.Models.InstancePermissionSet</a></div><div class="ttdef"><b>Definition:</b> <a href="_tgstation_8_server_8_host_2_models_2_instance_permission_set_8cs_source.html#l00008">InstancePermissionSet.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context.html">Tgstation.Server.Host.Security.AuthenticationContext</a></div><div class="ttdef"><b>Definition:</b> <a href="_authentication_context_8cs_source.html#l00010">AuthenticationContext.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context_html_a2414cfa202796c6e1b630baa48e2f800"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context.html#a2414cfa202796c6e1b630baa48e2f800">Tgstation.Server.Host.Security.AuthenticationContext.InstancePermissionSet</a></div><div class="ttdeci">InstancePermissionSet? InstancePermissionSet</div><div class="ttdoc">The User's effective Models.InstancePermissionSet if applicable.</div><div class="ttdef"><b>Definition:</b> <a href="_authentication_context_8cs_source.html#l00022">AuthenticationContext.cs:22</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_instance_manager_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_instance_manager.html">Tgstation.Server.Host.Components.IInstanceManager</a></div><div class="ttdoc">For managing IInstances.</div><div class="ttdef"><b>Definition:</b> <a href="_i_instance_manager_8cs_source.html#l00010">IInstanceManager.cs:11</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">Tgstation.Server.Host.Database.IDatabaseContext</a></div><div class="ttdoc">Represents the database.</div><div class="ttdef"><b>Definition:</b> <a href="_i_database_context_8cs_source.html#l00016">IDatabaseContext.cs:17</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context.html">Tgstation.Server.Host.Security.IAuthenticationContext</a></div><div class="ttdoc">Represents the currently authenticated Models.User.</div><div class="ttdef"><b>Definition:</b> <a href="_i_authentication_context_8cs_source.html#l00009">IAuthenticationContext.cs:10</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_api_headers_provider_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_api_headers_provider.html">Tgstation.Server.Host.Utils.IApiHeadersProvider</a></div><div class="ttdoc">Provides ApiHeaders.</div><div class="ttdef"><b>Definition:</b> <a href="_i_api_headers_provider_8cs_source.html#l00008">IApiHeadersProvider.cs:9</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_components_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_components.html">Tgstation.Server.Host.Components</a></div><div class="ttdef"><b>Definition:</b> <a href="_byond_executable_lock_8cs_source.html#l00005">ByondExecutableLock.cs:6</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_components_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_components.html">Tgstation.Server.Host.Components</a></div><div class="ttdef"><b>Definition:</b> <a href="_channel_mapping_8cs_source.html#l00003">ChannelMapping.cs:4</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_controllers_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers.html">Tgstation.Server.Host.Controllers</a></div><div class="ttdef"><b>Definition:</b> <a href="_administration_controller_8cs_source.html#l00032">AdministrationController.cs:33</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_database_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_database.html">Tgstation.Server.Host.Database</a></div><div class="ttdef"><b>Definition:</b> <a href="_database_collection_8cs_source.html#l00010">DatabaseCollection.cs:11</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_security_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a></div><div class="ttdef"><b>Definition:</b> <a href="_authentication_context_8cs_source.html#l00007">AuthenticationContext.cs:8</a></div></div>