Files
tgstation-server/_default_git_remote_features_8cs_source.html

138 lines
19 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.Host/Components/Repository/DefaultGitRemoteFeatures.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_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_7a3fd032a1362a6005a1fc9227a8dd86.html">Components</a></li><li class="navelem"><a class="el" href="dir_5d46d0c3fd1cac5ce1ea23751ad25792.html">Repository</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">DefaultGitRemoteFeatures.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_default_git_remote_features_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.Threading;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Threading.Tasks;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a>;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="foldopen" id="foldopen00007" data-start="{" data-end="}">
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"><a class="line" href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository.html"> 7</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository.html">Tgstation.Server.Host.Components.Repository</a></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>{</div>
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html"> 12</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_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html">DefaultGitRemoteFeatures</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_i_git_remote_features.html">IGitRemoteFeatures</a></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a67c7a2ed5ab0cad4e6936bd8560bd8aa"> 15</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a67c7a2ed5ab0cad4e6936bd8560bd8aa">TestMergeRefSpecFormatter</a> =&gt; <span class="keywordflow">throw</span> <span class="keyword">new</span> NotSupportedException();</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </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_components_1_1_repository_1_1_default_git_remote_features.html#a570d009ce0dee12fd5e4b342d40784ed"> 18</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a570d009ce0dee12fd5e4b342d40784ed">TestMergeLocalBranchNameFormatter</a> =&gt; <span class="keywordflow">throw</span> <span class="keyword">new</span> NotSupportedException();</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a704ed2419e4ba42714950984fb1627c0"> 21</a></span> <span class="keyword">public</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#aaff5188f30ee5c04c081684eb9672f17">RemoteGitProvider</a>? <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#aaff5188f30ee5c04c081684eb9672f17">RemoteGitProvider</a> =&gt; Api.Models.RemoteGitProvider.Unknown;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a44391fbad2c1aae0f770908c4201cb91"> 24</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a44391fbad2c1aae0f770908c4201cb91">RemoteRepositoryOwner</a> =&gt; <span class="keyword">null</span>;</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_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a4d9a83fe97583a9ec1e16533eb60b137"> 27</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a4d9a83fe97583a9ec1e16533eb60b137">RemoteRepositoryName</a> =&gt; <span class="keyword">null</span>;</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_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a361ad9df4090584b4fe665ba0e749573"> 30</a></span> <span class="keyword">public</span> ValueTask&lt;Models.TestMerge&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a361ad9df4090584b4fe665ba0e749573">GetTestMerge</a>(</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html">TestMergeParameters</a> parameters,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_repository_settings.html">RepositorySettings</a> repositorySettings,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> CancellationToken cancellationToken) =&gt; <span class="keywordflow">throw</span> <span class="keyword">new</span> NotSupportedException();</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_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a4bc9fcf98ea50da29688618be9084fa7"> 36</a></span> <span class="keyword">public</span> ValueTask&lt;string?&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a4bc9fcf98ea50da29688618be9084fa7">TransformRepositoryPassword</a>(<span class="keywordtype">string</span>? rawPassword, CancellationToken cancellationToken)</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> =&gt; ValueTask.FromResult(rawPassword);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>}</div>
</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_repository_settings_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_repository_settings.html">Tgstation.Server.Api.Models.RepositorySettings</a></div><div class="ttdoc">Represents configurable settings for a git repository.</div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_repository_settings_8cs_source.html#l00008">RepositorySettings.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html">Tgstation.Server.Api.Models.TestMergeParameters</a></div><div class="ttdoc">Parameters for creating a TestMerge.</div><div class="ttdef"><b>Definition</b> <a href="_test_merge_parameters_8cs_source.html#l00008">TestMergeParameters.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html">Tgstation.Server.Host.Components.Repository.DefaultGitRemoteFeatures</a></div><div class="ttdoc">The IGitRemoteFeatures used for unknown providers.</div><div class="ttdef"><b>Definition</b> <a href="_default_git_remote_features_8cs_source.html#l00012">DefaultGitRemoteFeatures.cs:13</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features_html_a361ad9df4090584b4fe665ba0e749573"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a361ad9df4090584b4fe665ba0e749573">Tgstation.Server.Host.Components.Repository.DefaultGitRemoteFeatures.GetTestMerge</a></div><div class="ttdeci">ValueTask&lt; Models.TestMerge &gt; GetTestMerge(TestMergeParameters parameters, RepositorySettings repositorySettings, CancellationToken cancellationToken)</div><div class="ttdoc">Retrieve the Models.TestMerge representation of given test merge parameters .A ValueTask&lt;TResult&gt; res...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features_html_a44391fbad2c1aae0f770908c4201cb91"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a44391fbad2c1aae0f770908c4201cb91">Tgstation.Server.Host.Components.Repository.DefaultGitRemoteFeatures.RemoteRepositoryOwner</a></div><div class="ttdeci">string? RemoteRepositoryOwner</div><div class="ttdoc">If RemoteGitProvider is not RemoteGitProvider.Unknown this will be set with the owner of the reposito...</div><div class="ttdef"><b>Definition</b> <a href="_default_git_remote_features_8cs_source.html#l00024">DefaultGitRemoteFeatures.cs:24</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features_html_a4bc9fcf98ea50da29688618be9084fa7"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a4bc9fcf98ea50da29688618be9084fa7">Tgstation.Server.Host.Components.Repository.DefaultGitRemoteFeatures.TransformRepositoryPassword</a></div><div class="ttdeci">ValueTask&lt; string?&gt; TransformRepositoryPassword(string? rawPassword, CancellationToken cancellationToken)</div><div class="ttdoc">Transform a service's rawPassword into a password usable by git.A ValueTask&lt;TResult&gt; resulting in th...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features_html_a4d9a83fe97583a9ec1e16533eb60b137"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a4d9a83fe97583a9ec1e16533eb60b137">Tgstation.Server.Host.Components.Repository.DefaultGitRemoteFeatures.RemoteRepositoryName</a></div><div class="ttdeci">string? RemoteRepositoryName</div><div class="ttdoc">If RemoteGitProvider is not RemoteGitProvider.Unknown this will be set with the name of the repositor...</div><div class="ttdef"><b>Definition</b> <a href="_default_git_remote_features_8cs_source.html#l00027">DefaultGitRemoteFeatures.cs:27</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features_html_a570d009ce0dee12fd5e4b342d40784ed"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a570d009ce0dee12fd5e4b342d40784ed">Tgstation.Server.Host.Components.Repository.DefaultGitRemoteFeatures.TestMergeLocalBranchNameFormatter</a></div><div class="ttdeci">string TestMergeLocalBranchNameFormatter</div><div class="ttdoc">Get.</div><div class="ttdef"><b>Definition</b> <a href="_default_git_remote_features_8cs_source.html#l00018">DefaultGitRemoteFeatures.cs:18</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features_html_a67c7a2ed5ab0cad4e6936bd8560bd8aa"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_default_git_remote_features.html#a67c7a2ed5ab0cad4e6936bd8560bd8aa">Tgstation.Server.Host.Components.Repository.DefaultGitRemoteFeatures.TestMergeRefSpecFormatter</a></div><div class="ttdeci">string TestMergeRefSpecFormatter</div><div class="ttdoc">Gets a formatter string which creates the remote refspec for fetching the HEAD of passed in test merg...</div><div class="ttdef"><b>Definition</b> <a href="_default_git_remote_features_8cs_source.html#l00015">DefaultGitRemoteFeatures.cs:15</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_i_git_remote_features_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_i_git_remote_features.html">Tgstation.Server.Host.Components.Repository.IGitRemoteFeatures</a></div><div class="ttdoc">Provides features for remote git services.</div><div class="ttdef"><b>Definition</b> <a href="_i_git_remote_features_8cs_source.html#l00009">IGitRemoteFeatures.cs:10</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_aaff5188f30ee5c04c081684eb9672f17"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#aaff5188f30ee5c04c081684eb9672f17">Tgstation.Server.Api.Models.RemoteGitProvider</a></div><div class="ttdeci">RemoteGitProvider</div><div class="ttdoc">Indicates the remote git host.</div><div class="ttdef"><b>Definition</b> <a href="_remote_git_provider_8cs_source.html#l00006">RemoteGitProvider.cs:7</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository.html">Tgstation.Server.Host.Components.Repository</a></div><div class="ttdef"><b>Definition</b> <a href="_default_git_remote_features_8cs_source.html#l00007">DefaultGitRemoteFeatures.cs:8</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>