jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-05-12 15:52:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e73aed8d9f80d0cc84deaa62cccdf927286e8c87
github-api/apidocs/org/kohsuke/github/package-summary.html
Kohsuke Kawaguchi e73aed8d9f Wagon: Deploying site to repository
2013-11-09 15:22:20 -08:00

460 lines
19 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 (version 1.7.0_15) on Sat Nov 09 15:22:00 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.kohsuke.github (GitHub API for Java 1.45 API)</title>
<meta name="date" content="2013-11-09">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.kohsuke.github (GitHub API for Java 1.45 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../org/kohsuke/github/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="package-use.html">Use</a></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 Package</li>
<li>Next Package</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/github/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All 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">
<h1 title="Package" class="title">Package&nbsp;org.kohsuke.github</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHAsset.html" title="class in org.kohsuke.github">GHAsset</a></td>
<td class="colLast">
<div class="block">Asset in a release.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a></td>
<td class="colLast">
<div class="block">Generated OAuth token</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHBranch.html" title="class in org.kohsuke.github">GHBranch</a></td>
<td class="colLast">
<div class="block">A branch in a repository.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHBranch.Commit.html" title="class in org.kohsuke.github">GHBranch.Commit</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCommit.html" title="class in org.kohsuke.github">GHCommit</a></td>
<td class="colLast">
<div class="block">A commit in a repository.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCommit.File.html" title="class in org.kohsuke.github">GHCommit.File</a></td>
<td class="colLast">
<div class="block">A file that was modified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCommit.GHAuthor.html" title="class in org.kohsuke.github">GHCommit.GHAuthor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCommit.Parent.html" title="class in org.kohsuke.github">GHCommit.Parent</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCommit.ShortInfo.html" title="class in org.kohsuke.github">GHCommit.ShortInfo</a></td>
<td class="colLast">
<div class="block">Short summary of this commit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCommit.Stats.html" title="class in org.kohsuke.github">GHCommit.Stats</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCommitComment.html" title="class in org.kohsuke.github">GHCommitComment</a></td>
<td class="colLast">
<div class="block">A comment attached to a commit (or a specific line in a specific file of a commit.)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCommitPointer.html" title="class in org.kohsuke.github">GHCommitPointer</a></td>
<td class="colLast">
<div class="block">Identifies a commit in <a href="../../../org/kohsuke/github/GHPullRequest.html" title="class in org.kohsuke.github"><code>GHPullRequest</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCommitStatus.html" title="class in org.kohsuke.github">GHCommitStatus</a></td>
<td class="colLast">
<div class="block">Represents a status of a commit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCompare.html" title="class in org.kohsuke.github">GHCompare</a></td>
<td class="colLast">
<div class="block">The model user for comparing 2 commits in the GitHub API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCompare.Commit.html" title="class in org.kohsuke.github">GHCompare.Commit</a></td>
<td class="colLast">
<div class="block">Compare commits had a child commit element with additional details we want to capture.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCompare.InnerCommit.html" title="class in org.kohsuke.github">GHCompare.InnerCommit</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCompare.Tree.html" title="class in org.kohsuke.github">GHCompare.Tree</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCompare.User.html" title="class in org.kohsuke.github">GHCompare.User</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHEventInfo.html" title="class in org.kohsuke.github">GHEventInfo</a></td>
<td class="colLast">
<div class="block">Represents an event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHEventInfo.GHEventRepository.html" title="class in org.kohsuke.github">GHEventInfo.GHEventRepository</a></td>
<td class="colLast">
<div class="block">Inside the event JSON model, GitHub uses a slightly different format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHEventPayload.html" title="class in org.kohsuke.github">GHEventPayload</a></td>
<td class="colLast">
<div class="block">Base type for types used in databinding of the event payload.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHEventPayload.IssueComment.html" title="class in org.kohsuke.github">GHEventPayload.IssueComment</a></td>
<td class="colLast">
<div class="block">A comment was added to an issue</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHEventPayload.PullRequest.html" title="class in org.kohsuke.github">GHEventPayload.PullRequest</a></td>
<td class="colLast">
<div class="block">A pull request status has changed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHHook.html" title="class in org.kohsuke.github">GHHook</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></td>
<td class="colLast">
<div class="block">Represents an issue on GitHub.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHIssue.Label.html" title="class in org.kohsuke.github">GHIssue.Label</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHIssue.PullRequest.html" title="class in org.kohsuke.github">GHIssue.PullRequest</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHIssueBuilder.html" title="class in org.kohsuke.github">GHIssueBuilder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHIssueComment.html" title="class in org.kohsuke.github">GHIssueComment</a></td>
<td class="colLast">
<div class="block">Comment to the issue</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHKey.html" title="class in org.kohsuke.github">GHKey</a></td>
<td class="colLast">
<div class="block">SSH public key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHMyself.html" title="class in org.kohsuke.github">GHMyself</a></td>
<td class="colLast">
<div class="block">Represents the account that's logging into GitHub.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHPerson.html" title="class in org.kohsuke.github">GHPerson</a></td>
<td class="colLast">
<div class="block">Common part of <a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github"><code>GHUser</code></a> and <a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github"><code>GHOrganization</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHPersonSet.html" title="class in org.kohsuke.github">GHPersonSet</a>&lt;T extends <a href="../../../org/kohsuke/github/GHPerson.html" title="class in org.kohsuke.github">GHPerson</a>&gt;</td>
<td class="colLast">
<div class="block">Set of <a href="../../../org/kohsuke/github/GHPerson.html" title="class in org.kohsuke.github"><code>GHPerson</code></a> with helper lookup methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a></td>
<td class="colLast">
<div class="block">A pull request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHPullRequestCommitDetail.html" title="class in org.kohsuke.github">GHPullRequestCommitDetail</a></td>
<td class="colLast">
<div class="block">Commit detail inside a <a href="../../../org/kohsuke/github/GHPullRequest.html" title="class in org.kohsuke.github"><code>GHPullRequest</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHPullRequestCommitDetail.Authorship.html" title="class in org.kohsuke.github">GHPullRequestCommitDetail.Authorship</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHPullRequestCommitDetail.Commit.html" title="class in org.kohsuke.github">GHPullRequestCommitDetail.Commit</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHPullRequestCommitDetail.CommitPointer.html" title="class in org.kohsuke.github">GHPullRequestCommitDetail.CommitPointer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHPullRequestCommitDetail.Tree.html" title="class in org.kohsuke.github">GHPullRequestCommitDetail.Tree</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a></td>
<td class="colLast">
<div class="block">Rate limit.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHRef.html" title="class in org.kohsuke.github">GHRef</a></td>
<td class="colLast">
<div class="block">Provides information on a Git ref from GitHub.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHRef.GHObject.html" title="class in org.kohsuke.github">GHRef.GHObject</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHRelease.html" title="class in org.kohsuke.github">GHRelease</a></td>
<td class="colLast">
<div class="block">Release in a github repository.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHReleaseBuilder.html" title="class in org.kohsuke.github">GHReleaseBuilder</a></td>
<td class="colLast">
<div class="block">Builder pattern for creating a <a href="../../../org/kohsuke/github/GHRelease.html" title="class in org.kohsuke.github"><code>GHRelease</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHRepository.html" title="class in org.kohsuke.github">GHRepository</a></td>
<td class="colLast">
<div class="block">A repository on GitHub.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHTeam.html" title="class in org.kohsuke.github">GHTeam</a></td>
<td class="colLast">
<div class="block">A team in GitHub organization.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a></td>
<td class="colLast">
<div class="block">Represents an user of GitHub.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></td>
<td class="colLast">
<div class="block">Root of the GitHub API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block"><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> that returns <a href="../../../org/kohsuke/github/PagedIterator.html" title="class in org.kohsuke.github"><code>PagedIterator</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/PagedIterator.html" title="class in org.kohsuke.github">PagedIterator</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Iterator over a pagenated data source.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCommitState.html" title="enum in org.kohsuke.github">GHCommitState</a></td>
<td class="colLast">
<div class="block">Represents the state of commit</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHCompare.Status.html" title="enum in org.kohsuke.github">GHCompare.Status</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHEvent.html" title="enum in org.kohsuke.github">GHEvent</a></td>
<td class="colLast">
<div class="block">Hook event type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHMilestoneState.html" title="enum in org.kohsuke.github">GHMilestoneState</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHOrganization.Permission.html" title="enum in org.kohsuke.github">GHOrganization.Permission</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/github/GHException.html" title="class in org.kohsuke.github">GHException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../org/kohsuke/github/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="package-use.html">Use</a></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 Package</li>
<li>Next Package</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/github/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All 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; 2013. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink