jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-05-11 00:11:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0d424cedfa900c8a5a0e44babc2eeb708a488799
github-api/apidocs/org/kohsuke/github/class-use/GitHub.html
Kohsuke Kawaguchi 0d424cedfa Wagon: Deploying site to repository
2017-10-28 16:01:47 -07:00

308 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sat Oct 28 16:00:54 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class org.kohsuke.github.GitHub (GitHub API for Java 1.90 API)</title>
<meta name="date" content="2017-10-28">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Class org.kohsuke.github.GitHub (GitHub API for Java 1.90 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/kohsuke/github/class-use/GitHub.html" target="_top">Frames</a></li>
<li><a href="GitHub.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.kohsuke.github.GitHub" class="title">Uses of Class<br>org.kohsuke.github.GitHub</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.kohsuke.github">org.kohsuke.github</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.kohsuke.github">
<!-- -->
</a>
<h3>Uses of <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> in <a href="../../../../org/kohsuke/github/package-summary.html">org.kohsuke.github</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation">
<caption><span>Fields in <a href="../../../../org/kohsuke/github/package-summary.html">org.kohsuke.github</a> declared as <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GHEventPayload.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHEventPayload.html#root">root</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GHQueryBuilder.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHQueryBuilder.html#root">root</a></span></code>&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../org/kohsuke/github/package-summary.html">org.kohsuke.github</a> that return <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHubBuilder.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHubBuilder.html#build--">build</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connect--">connect</a></span>()</code>
<div class="block">Obtains the credential from "~/.github" or from the System Environment Properties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connect-java.lang.String-java.lang.String-">connect</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;login,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthAccessToken)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connect-java.lang.String-java.lang.String-java.lang.String-">connect</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;login,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthAccessToken,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Either OAuth token or password is sufficient, so there's no point in passing both.
Use <a href="../../../../org/kohsuke/github/GitHub.html#connectUsingPassword-java.lang.String-java.lang.String-"><code>connectUsingPassword(String, String)</code></a> or <a href="../../../../org/kohsuke/github/GitHub.html#connectUsingOAuth-java.lang.String-"><code>connectUsingOAuth(String)</code></a>.</span></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connectAnonymously--">connectAnonymously</a></span>()</code>
<div class="block">Connects to GitHub anonymously.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connectToEnterprise-java.lang.String-java.lang.String-">connectToEnterprise</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;apiUrl,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthAccessToken)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../org/kohsuke/github/GitHub.html#connectToEnterpriseWithOAuth-java.lang.String-java.lang.String-java.lang.String-"><code>connectToEnterpriseWithOAuth(String, String, String)</code></a></span></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connectToEnterprise-java.lang.String-java.lang.String-java.lang.String-">connectToEnterprise</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;apiUrl,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;login,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use with caution. Login with password is not a preferred method.</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connectToEnterpriseAnonymously-java.lang.String-">connectToEnterpriseAnonymously</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;apiUrl)</code>
<div class="block">Connects to GitHub Enterprise anonymously.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connectToEnterpriseWithOAuth-java.lang.String-java.lang.String-java.lang.String-">connectToEnterpriseWithOAuth</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;apiUrl,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;login,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthAccessToken)</code>
<div class="block">Version that connects to GitHub Enterprise.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connectUsingOAuth-java.lang.String-">connectUsingOAuth</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthAccessToken)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connectUsingOAuth-java.lang.String-java.lang.String-">connectUsingOAuth</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;githubServer,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthAccessToken)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#connectUsingPassword-java.lang.String-java.lang.String-">connectUsingPassword</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;login,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GHAuthorization.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHAuthorization.html#getRoot--">getRoot</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GHRelease.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHRelease.html#getRoot--">getRoot</a></span>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GHBranch.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHBranch.html#getRoot--">getRoot</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GHKey.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHKey.html#getRoot--">getRoot</a></span>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GHAsset.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHAsset.html#getRoot--">getRoot</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GHTagObject.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHTagObject.html#getRoot--">getRoot</a></span>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GHMilestone.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHMilestone.html#getRoot--">getRoot</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GHTag.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHTag.html#getRoot--">getRoot</a></span>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><span class="typeNameLabel">GitHub.</span><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GitHub.html#offline--">offline</a></span>()</code>
<div class="block">An offline-only <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github"><code>GitHub</code></a> useful for parsing event notification from an unknown source.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
<caption><span>Constructors in <a href="../../../../org/kohsuke/github/package-summary.html">org.kohsuke.github</a> with parameters of type <a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/kohsuke/github/GHGistBuilder.html#GHGistBuilder-org.kohsuke.github.GitHub-">GHGistBuilder</a></span>(<a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;root)</code>&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/kohsuke/github/class-use/GitHub.html" target="_top">Frames</a></li>
<li><a href="GitHub.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink