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

128 lines
17 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.Host/Utils/GitHub/IAuthenticatedGitHubService.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_e031aa0fb63a9784d5d0be33d19ac57a.html">Utils</a></li><li class="navelem"><a class="el" href="dir_34174031dc2d9c0ba355c3cad87bf8ee.html">GitHub</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">IAuthenticatedGitHubService.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_authenticated_git_hub_service_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.Threading;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Threading.Tasks;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>Octokit;</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">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub.html">Tgstation.Server.Host.Utils.GitHub</a></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span>{</div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html"> 11</a></span> <span class="keyword">public</span> <span class="keyword">interface </span><a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html">IAuthenticatedGitHubService</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service.html">IGitHubService</a></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#a438b060b1d0dc692e4f1e5610c8a9f44"> 17</a></span> <span class="keywordtype">string</span> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#a438b060b1d0dc692e4f1e5610c8a9f44">GetGitPassword</a>();</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#ae02758afd50df9fb00d4ebdd2639d620"> 28</a></span> Task <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#ae02758afd50df9fb00d4ebdd2639d620">CommentOnIssue</a>(<span class="keywordtype">string</span> repoOwner, <span class="keywordtype">string</span> repoName, <span class="keywordtype">string</span> comment, <span class="keywordtype">int</span> issueNumber, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#aaad1f9eb1e08c50fd324fa4459ccf547"> 39</a></span> Task <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#aaad1f9eb1e08c50fd324fa4459ccf547">AppendCommentOnIssue</a>(<span class="keywordtype">string</span> repoOwner, <span class="keywordtype">string</span> repoName, <span class="keywordtype">string</span> comment, IssueComment issueComment, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#a0cb610efbe9a15c8c7524dc16a46d7bb"> 50</a></span> ValueTask&lt;IssueComment?&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#a0cb610efbe9a15c8c7524dc16a46d7bb">GetExistingCommentOnIssue</a>(<span class="keywordtype">string</span> repoOwner, <span class="keywordtype">string</span> repoName, <span class="keywordtype">string</span> header, <span class="keywordtype">int</span> issueNumber, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#a6ec88b25682381d11b7d39a4414383e0"> 60</a></span> ValueTask&lt;long&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#a6ec88b25682381d11b7d39a4414383e0">CreateDeployment</a>(NewDeployment newDeployment, <span class="keywordtype">string</span> repoOwner, <span class="keywordtype">string</span> repoName, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#afe4ffe75eea54d6dd06187485b9ccfea"> 71</a></span> Task <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#afe4ffe75eea54d6dd06187485b9ccfea">CreateDeploymentStatus</a>(NewDeploymentStatus newDeploymentStatus, <span class="keywordtype">string</span> repoOwner, <span class="keywordtype">string</span> repoName, <span class="keywordtype">long</span> deploymentId, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#ab58b902ee49d002e2cae4a5db55ed9af"> 81</a></span> Task <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#ab58b902ee49d002e2cae4a5db55ed9af">CreateDeploymentStatus</a>(NewDeploymentStatus newDeploymentStatus, <span class="keywordtype">long</span> repoId, <span class="keywordtype">long</span> deploymentId, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> }</div>
</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>}</div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html">Tgstation.Server.Host.Utils.GitHub.IAuthenticatedGitHubService</a></div><div class="ttdoc">IGitHubService that exposes functions that require authentication.</div><div class="ttdef"><b>Definition</b> <a href="_i_authenticated_git_hub_service_8cs_source.html#l00011">IAuthenticatedGitHubService.cs:12</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service_html_a0cb610efbe9a15c8c7524dc16a46d7bb"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#a0cb610efbe9a15c8c7524dc16a46d7bb">Tgstation.Server.Host.Utils.GitHub.IAuthenticatedGitHubService.GetExistingCommentOnIssue</a></div><div class="ttdeci">ValueTask&lt; IssueComment?&gt; GetExistingCommentOnIssue(string repoOwner, string repoName, string header, int issueNumber, CancellationToken cancellationToken)</div><div class="ttdoc">Gets an IssueComment for a particular issueNumber with the provided header if it exists and is not ...</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service_html_a438b060b1d0dc692e4f1e5610c8a9f44"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#a438b060b1d0dc692e4f1e5610c8a9f44">Tgstation.Server.Host.Utils.GitHub.IAuthenticatedGitHubService.GetGitPassword</a></div><div class="ttdeci">string GetGitPassword()</div><div class="ttdoc">Gets the password to use for accessing a given repository.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service_html_a6ec88b25682381d11b7d39a4414383e0"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#a6ec88b25682381d11b7d39a4414383e0">Tgstation.Server.Host.Utils.GitHub.IAuthenticatedGitHubService.CreateDeployment</a></div><div class="ttdeci">ValueTask&lt; long &gt; CreateDeployment(NewDeployment newDeployment, string repoOwner, string repoName, CancellationToken cancellationToken)</div><div class="ttdoc">Create a newDeployment on a target repostiory.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service_html_aaad1f9eb1e08c50fd324fa4459ccf547"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#aaad1f9eb1e08c50fd324fa4459ccf547">Tgstation.Server.Host.Utils.GitHub.IAuthenticatedGitHubService.AppendCommentOnIssue</a></div><div class="ttdeci">Task AppendCommentOnIssue(string repoOwner, string repoName, string comment, IssueComment issueComment, CancellationToken cancellationToken)</div><div class="ttdoc">Append a comment on an existing issueComment .</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service_html_ab58b902ee49d002e2cae4a5db55ed9af"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#ab58b902ee49d002e2cae4a5db55ed9af">Tgstation.Server.Host.Utils.GitHub.IAuthenticatedGitHubService.CreateDeploymentStatus</a></div><div class="ttdeci">Task CreateDeploymentStatus(NewDeploymentStatus newDeploymentStatus, long repoId, long deploymentId, CancellationToken cancellationToken)</div><div class="ttdoc">Create a newDeploymentStatus on a target deployment.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service_html_ae02758afd50df9fb00d4ebdd2639d620"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#ae02758afd50df9fb00d4ebdd2639d620">Tgstation.Server.Host.Utils.GitHub.IAuthenticatedGitHubService.CommentOnIssue</a></div><div class="ttdeci">Task CommentOnIssue(string repoOwner, string repoName, string comment, int issueNumber, CancellationToken cancellationToken)</div><div class="ttdoc">Create a comment on a given issueNumber .</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service_html_afe4ffe75eea54d6dd06187485b9ccfea"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_authenticated_git_hub_service.html#afe4ffe75eea54d6dd06187485b9ccfea">Tgstation.Server.Host.Utils.GitHub.IAuthenticatedGitHubService.CreateDeploymentStatus</a></div><div class="ttdeci">Task CreateDeploymentStatus(NewDeploymentStatus newDeploymentStatus, string repoOwner, string repoName, long deploymentId, CancellationToken cancellationToken)</div><div class="ttdoc">Create a newDeploymentStatus on a target deployment.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_service.html">Tgstation.Server.Host.Utils.GitHub.IGitHubService</a></div><div class="ttdoc">Service for interacting with the GitHub API.</div><div class="ttdef"><b>Definition</b> <a href="_i_git_hub_service_8cs_source.html#l00015">IGitHubService.cs:16</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub.html">Tgstation.Server.Host.Utils.GitHub</a></div><div class="ttdef"><b>Definition</b> <a href="_git_hub_client_factory_8cs_source.html#l00022">GitHubClientFactory.cs:23</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