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_git_hub_client_factory_8cs_source.html
T

119 lines
12 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/IGitHubClientFactory.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">IGitHubClientFactory.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_git_hub_client_factory_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_git_hub_client_factory.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_git_hub_client_factory.html">IGitHubClientFactory</a></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> {</div>
<div class="line"><a id="l00018" name="l00018"></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_git_hub_client_factory.html#a401cf4b0e26d478e741e195ac02563eb"> 18</a></span> ValueTask&lt;IGitHubClient&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_git_hub_client_factory.html#a401cf4b0e26d478e741e195ac02563eb">CreateClient</a>(CancellationToken cancellationToken);</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00026" name="l00026"></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_git_hub_client_factory.html#aaee2563f4a0bc25bbec554b03e34d888"> 26</a></span> ValueTask&lt;IGitHubClient&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_git_hub_client_factory.html#aaee2563f4a0bc25bbec554b03e34d888">CreateClient</a>(<span class="keywordtype">string</span> accessToken, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00035" name="l00035"></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_git_hub_client_factory.html#a3a92711bc701286ce65bd637c0f9dc7b"> 35</a></span> ValueTask&lt;IGitHubClient?&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_git_hub_client_factory.html#a3a92711bc701286ce65bd637c0f9dc7b">CreateClientForRepository</a>(<span class="keywordtype">string</span> accessString, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_repository_identifier.html">RepositoryIdentifier</a> repositoryIdentifier, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00042" name="l00042"></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_git_hub_client_factory.html#aa5d1848316036724f9d9cf073539b879"> 42</a></span> IGitHubClient? <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_i_git_hub_client_factory.html#aa5d1848316036724f9d9cf073539b879">CreateAppClient</a>(<span class="keywordtype">string</span> tgsEncodedAppPrivateKey);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_repository_identifier_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_git_hub_1_1_repository_identifier.html">Tgstation.Server.Host.Utils.GitHub.RepositoryIdentifier</a></div><div class="ttdoc">Identifies a repository either by its RepositoryId or Owner and Name.</div><div class="ttdef"><b>Definition</b> <a href="_repository_identifier_8cs_source.html#l00012">RepositoryIdentifier.cs:13</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_git_hub_client_factory_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_client_factory.html">Tgstation.Server.Host.Utils.GitHub.IGitHubClientFactory</a></div><div class="ttdoc">For creating IGitHubClients.</div><div class="ttdef"><b>Definition</b> <a href="_i_git_hub_client_factory_8cs_source.html#l00011">IGitHubClientFactory.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_git_hub_client_factory_html_a3a92711bc701286ce65bd637c0f9dc7b"><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_client_factory.html#a3a92711bc701286ce65bd637c0f9dc7b">Tgstation.Server.Host.Utils.GitHub.IGitHubClientFactory.CreateClientForRepository</a></div><div class="ttdeci">ValueTask&lt; IGitHubClient?&gt; CreateClientForRepository(string accessString, RepositoryIdentifier repositoryIdentifier, CancellationToken cancellationToken)</div><div class="ttdoc">Creates a GitHub client that will only be used for a given repositoryIdentifier .</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_client_factory_html_a401cf4b0e26d478e741e195ac02563eb"><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_client_factory.html#a401cf4b0e26d478e741e195ac02563eb">Tgstation.Server.Host.Utils.GitHub.IGitHubClientFactory.CreateClient</a></div><div class="ttdeci">ValueTask&lt; IGitHubClient &gt; CreateClient(CancellationToken cancellationToken)</div><div class="ttdoc">Create a IGitHubClient client. Low rate limit unless the server's GitHubAccessToken is set to bypass ...</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_client_factory_html_aa5d1848316036724f9d9cf073539b879"><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_client_factory.html#aa5d1848316036724f9d9cf073539b879">Tgstation.Server.Host.Utils.GitHub.IGitHubClientFactory.CreateAppClient</a></div><div class="ttdeci">IGitHubClient? CreateAppClient(string tgsEncodedAppPrivateKey)</div><div class="ttdoc">Create an App (not installation) authenticated IGitHubClient.</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_client_factory_html_aaee2563f4a0bc25bbec554b03e34d888"><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_client_factory.html#aaee2563f4a0bc25bbec554b03e34d888">Tgstation.Server.Host.Utils.GitHub.IGitHubClientFactory.CreateClient</a></div><div class="ttdeci">ValueTask&lt; IGitHubClient &gt; CreateClient(string accessToken, CancellationToken cancellationToken)</div><div class="ttdoc">Create a client with authentication using a personal access token.</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