Files
tgstation-server/_job_code_extensions_8cs_source.html

120 lines
9.9 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.Api/Extensions/JobCodeExtensions.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_2ea2465064f3ff030c6dd6700a328d91.html">Tgstation.Server.Api</a></li><li class="navelem"><a class="el" href="dir_0a678e0b2c50668b3207624ecfc81531.html">Extensions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">JobCodeExtensions.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_job_code_extensions_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> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</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="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="foldopen" id="foldopen00005" data-start="{" data-end="}">
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"><a class="line" href="namespace_tgstation_1_1_server_1_1_api_1_1_extensions.html"> 5</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api_1_1_extensions.html">Tgstation.Server.Api.Extensions</a></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span>{</div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="};">
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_extensions_1_1_job_code_extensions.html"> 10</a></span> <span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_extensions_1_1_job_code_extensions.html">JobCodeExtensions</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> {</div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="}">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_api_1_1_extensions_1_1_job_code_extensions.html#a4ff5f80a28a9b5fa56bdb60bd610f374"> 17</a></span> <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_api_1_1_extensions_1_1_job_code_extensions.html#a4ff5f80a28a9b5fa56bdb60bd610f374">IsServerStartupJob</a>(<span class="keyword">this</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a7c8f30de4159253ce2ffec51771bed71">JobCode</a> jobCode)</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> =&gt; jobCode <span class="keywordflow">switch</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> JobCode.Unknown or JobCode.Move or JobCode.RepositoryClone or JobCode.RepositoryUpdate or JobCode.RepositoryAutoUpdate or JobCode.RepositoryDelete or JobCode.EngineOfficialInstall or JobCode.EngineCustomInstall or JobCode.EngineDelete or JobCode.Deployment or JobCode.AutomaticDeployment or JobCode.WatchdogLaunch or JobCode.WatchdogRestart or JobCode.WatchdogDump =&gt; <span class="keyword">false</span>,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> JobCode.StartupWatchdogLaunch or JobCode.StartupWatchdogReattach or JobCode.ReconnectChatBot =&gt; <span class="keyword">true</span>,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> _ =&gt; <span class="keywordflow">throw</span> <span class="keyword">new</span> InvalidOperationException($<span class="stringliteral">&quot;Invalid JobCode: {jobCode}&quot;</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>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>}</div>
</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_extensions_1_1_job_code_extensions_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_extensions_1_1_job_code_extensions.html">Tgstation.Server.Api.Extensions.JobCodeExtensions</a></div><div class="ttdoc">Extension methods for the JobCode enum.</div><div class="ttdef"><b>Definition</b> <a href="_job_code_extensions_8cs_source.html#l00010">JobCodeExtensions.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_extensions_1_1_job_code_extensions_html_a4ff5f80a28a9b5fa56bdb60bd610f374"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_extensions_1_1_job_code_extensions.html#a4ff5f80a28a9b5fa56bdb60bd610f374">Tgstation.Server.Api.Extensions.JobCodeExtensions.IsServerStartupJob</a></div><div class="ttdeci">static bool IsServerStartupJob(this JobCode jobCode)</div><div class="ttdoc">If a given jobCode can be triggered by TGS startup.</div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_extensions_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_extensions.html">Tgstation.Server.Api.Extensions</a></div><div class="ttdef"><b>Definition</b> <a href="_job_code_extensions_8cs_source.html#l00005">JobCodeExtensions.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_1_1_models_html_a7c8f30de4159253ce2ffec51771bed71"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a7c8f30de4159253ce2ffec51771bed71">Tgstation.Server.Api.Models.JobCode</a></div><div class="ttdeci">JobCode</div><div class="ttdoc">The different types of Response.JobResponse.</div><div class="ttdef"><b>Definition</b> <a href="_job_code_8cs_source.html#l00008">JobCode.cs:9</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>