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
bfa3fa536c2b3b952d37a82dc4985fcc55ea78bd
github-api/apidocs/org/kohsuke/github/GHPullRequest.html
Kohsuke Kawaguchi bfa3fa536c Wagon: Deploying site to repository
2016-06-03 00:23:26 -07:00

829 lines
37 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) on Fri Jun 03 00:22:58 PDT 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GHPullRequest (GitHub API for Java 1.76 API)</title>
<meta name="date" content="2016-06-03">
<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="GHPullRequest (GitHub API for Java 1.76 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":42,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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 class="navBarCell1Rev">Class</li>
<li><a href="class-use/GHPullRequest.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><a href="../../../org/kohsuke/github/GHPersonSet.html" title="class in org.kohsuke.github"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/kohsuke/github/GHPullRequestCommitDetail.html" title="class in org.kohsuke.github"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/github/GHPullRequest.html" target="_top">Frames</a></li>
<li><a href="GHPullRequest.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.kohsuke.github.GHIssue">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.kohsuke.github.GHIssue">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.kohsuke.github</div>
<h2 title="Class GHPullRequest" class="title">Class GHPullRequest</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../org/kohsuke/github/GHObject.html" title="class in org.kohsuke.github">org.kohsuke.github.GHObject</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">org.kohsuke.github.GHIssue</a></li>
<li>
<ul class="inheritance">
<li>org.kohsuke.github.GHPullRequest</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">GHPullRequest</span>
extends <a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></pre>
<div class="block">A pull request.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Kohsuke Kawaguchi</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/kohsuke/github/GHRepository.html#getPullRequest-int-"><code>GHRepository.getPullRequest(int)</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.kohsuke.github.GHIssue">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.kohsuke.github.<a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></h3>
<code><a href="../../../org/kohsuke/github/GHIssue.Label.html" title="class in org.kohsuke.github">GHIssue.Label</a>, <a href="../../../org/kohsuke/github/GHIssue.PullRequest.html" title="class in org.kohsuke.github">GHIssue.PullRequest</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.kohsuke.github.GHIssue">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.kohsuke.github.<a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></h3>
<code><a href="../../../org/kohsuke/github/GHIssue.html#assignee">assignee</a>, <a href="../../../org/kohsuke/github/GHIssue.html#body">body</a>, <a href="../../../org/kohsuke/github/GHIssue.html#closed_at">closed_at</a>, <a href="../../../org/kohsuke/github/GHIssue.html#closed_by">closed_by</a>, <a href="../../../org/kohsuke/github/GHIssue.html#comments">comments</a>, <a href="../../../org/kohsuke/github/GHIssue.html#html_url">html_url</a>, <a href="../../../org/kohsuke/github/GHIssue.html#labels">labels</a>, <a href="../../../org/kohsuke/github/GHIssue.html#milestone">milestone</a>, <a href="../../../org/kohsuke/github/GHIssue.html#number">number</a>, <a href="../../../org/kohsuke/github/GHIssue.html#pull_request">pull_request</a>, <a href="../../../org/kohsuke/github/GHIssue.html#state">state</a>, <a href="../../../org/kohsuke/github/GHIssue.html#title">title</a>, <a href="../../../org/kohsuke/github/GHIssue.html#user">user</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.kohsuke.github.GHObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.kohsuke.github.<a href="../../../org/kohsuke/github/GHObject.html" title="class in org.kohsuke.github">GHObject</a></h3>
<code><a href="../../../org/kohsuke/github/GHObject.html#created_at">created_at</a>, <a href="../../../org/kohsuke/github/GHObject.html#id">id</a>, <a href="../../../org/kohsuke/github/GHObject.html#updated_at">updated_at</a>, <a href="../../../org/kohsuke/github/GHObject.html#url">url</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#GHPullRequest--">GHPullRequest</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#createReviewComment-java.lang.String-java.lang.String-java.lang.String-int-">createReviewComment</a></span>(java.lang.String&nbsp;body,
java.lang.String&nbsp;sha,
java.lang.String&nbsp;path,
int&nbsp;position)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getAdditions--">getAdditions</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getApiRoute--">getApiRoute</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitPointer.html" title="class in org.kohsuke.github">GHCommitPointer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getBase--">getBase</a></span>()</code>
<div class="block">This points to where the change should be pulled into,
but I'm not really sure what exactly it means.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getChangedFiles--">getChangedFiles</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getClosedBy--">getClosedBy</a></span>()</code>
<div class="block">Reports who has closed the issue.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getDeletions--">getDeletions</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.net.URL</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getDiffUrl--">getDiffUrl</a></span>()</code>
<div class="block">The diff file,
like https://github.com/jenkinsci/jenkins/pull/100.diff</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitPointer.html" title="class in org.kohsuke.github">GHCommitPointer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getHead--">getHead</a></span>()</code>
<div class="block">The change that should be pulled.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getIssueUpdatedAt--">getIssueUpdatedAt</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.net.URL</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getIssueUrl--">getIssueUrl</a></span>()</code>
<div class="block">The URL of the patch file.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="../../../org/kohsuke/github/GHLabel.html" title="class in org.kohsuke.github">GHLabel</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getLabels--">getLabels</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getMergeable--">getMergeable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getMergeableState--">getMergeableState</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getMergeCommitSha--">getMergeCommitSha</a></span>()</code>
<div class="block">See <a href="https://developer.github.com/changes/2013-04-25-deprecating-merge-commit-sha">GitHub blog post</a></div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getMergedAt--">getMergedAt</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getMergedBy--">getMergedBy</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.net.URL</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getPatchUrl--">getPatchUrl</a></span>()</code>
<div class="block">The URL of the patch file.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHIssue.PullRequest.html" title="class in org.kohsuke.github">GHIssue.PullRequest</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getPullRequest--">getPullRequest</a></span>()</code>
<div class="block">Returns non-null if this issue is a shadow of a pull request.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#getReviewComments--">getReviewComments</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#isMerged--">isMerged</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="../../../org/kohsuke/github/GHPullRequestCommitDetail.html" title="class in org.kohsuke.github">GHPullRequestCommitDetail</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#listCommits--">listCommits</a></span>()</code>
<div class="block">Retrieves all the commits associated to this pull request.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="../../../org/kohsuke/github/GHPullRequestFileDetail.html" title="class in org.kohsuke.github">GHPullRequestFileDetail</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#listFiles--">listFiles</a></span>()</code>
<div class="block">Retrieves all the commits associated to this pull request.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="../../../org/kohsuke/github/GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#listReviewComments--">listReviewComments</a></span>()</code>
<div class="block">Obtains all the review comments associated with this pull request.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#merge-java.lang.String-">merge</a></span>(java.lang.String&nbsp;msg)</code>
<div class="block">Merge this pull request.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHPullRequest.html#merge-java.lang.String-java.lang.String-">merge</a></span>(java.lang.String&nbsp;msg,
java.lang.String&nbsp;sha)</code>
<div class="block">Merge this pull request.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.kohsuke.github.GHIssue">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.kohsuke.github.<a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></h3>
<code><a href="../../../org/kohsuke/github/GHIssue.html#assignTo-org.kohsuke.github.GHUser-">assignTo</a>, <a href="../../../org/kohsuke/github/GHIssue.html#close--">close</a>, <a href="../../../org/kohsuke/github/GHIssue.html#comment-java.lang.String-">comment</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getApiURL--">getApiURL</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getAssignee--">getAssignee</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getBody--">getBody</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getClosedAt--">getClosedAt</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getComments--">getComments</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getCommentsCount--">getCommentsCount</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getHtmlUrl--">getHtmlUrl</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getIssuesApiRoute--">getIssuesApiRoute</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getMilestone--">getMilestone</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getNumber--">getNumber</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getRepository--">getRepository</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getState--">getState</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getTitle--">getTitle</a>, <a href="../../../org/kohsuke/github/GHIssue.html#getUser--">getUser</a>, <a href="../../../org/kohsuke/github/GHIssue.html#isPullRequest--">isPullRequest</a>, <a href="../../../org/kohsuke/github/GHIssue.html#listComments--">listComments</a>, <a href="../../../org/kohsuke/github/GHIssue.html#reopen--">reopen</a>, <a href="../../../org/kohsuke/github/GHIssue.html#setBody-java.lang.String-">setBody</a>, <a href="../../../org/kohsuke/github/GHIssue.html#setLabels-java.lang.String...-">setLabels</a>, <a href="../../../org/kohsuke/github/GHIssue.html#setTitle-java.lang.String-">setTitle</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.kohsuke.github.GHObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.kohsuke.github.<a href="../../../org/kohsuke/github/GHObject.html" title="class in org.kohsuke.github">GHObject</a></h3>
<code><a href="../../../org/kohsuke/github/GHObject.html#getCreatedAt--">getCreatedAt</a>, <a href="../../../org/kohsuke/github/GHObject.html#getId--">getId</a>, <a href="../../../org/kohsuke/github/GHObject.html#getUpdatedAt--">getUpdatedAt</a>, <a href="../../../org/kohsuke/github/GHObject.html#getUrl--">getUrl</a>, <a href="../../../org/kohsuke/github/GHObject.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="GHPullRequest--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GHPullRequest</h4>
<pre>public&nbsp;GHPullRequest()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getApiRoute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApiRoute</h4>
<pre>protected&nbsp;java.lang.String&nbsp;getApiRoute()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../org/kohsuke/github/GHIssue.html#getApiRoute--">getApiRoute</a></code>&nbsp;in class&nbsp;<code><a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></code></dd>
</dl>
</li>
</ul>
<a name="getPatchUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPatchUrl</h4>
<pre>public&nbsp;java.net.URL&nbsp;getPatchUrl()</pre>
<div class="block">The URL of the patch file.
like https://github.com/jenkinsci/jenkins/pull/100.patch</div>
</li>
</ul>
<a name="getIssueUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIssueUrl</h4>
<pre>public&nbsp;java.net.URL&nbsp;getIssueUrl()</pre>
<div class="block">The URL of the patch file.
like https://github.com/jenkinsci/jenkins/pull/100.patch</div>
</li>
</ul>
<a name="getBase--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBase</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommitPointer.html" title="class in org.kohsuke.github">GHCommitPointer</a>&nbsp;getBase()</pre>
<div class="block">This points to where the change should be pulled into,
but I'm not really sure what exactly it means.</div>
</li>
</ul>
<a name="getHead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHead</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommitPointer.html" title="class in org.kohsuke.github">GHCommitPointer</a>&nbsp;getHead()</pre>
<div class="block">The change that should be pulled. The tip of the commits to merge.</div>
</li>
</ul>
<a name="getIssueUpdatedAt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIssueUpdatedAt</h4>
<pre>@Deprecated
public&nbsp;java.util.Date&nbsp;getIssueUpdatedAt()
throws java.io.IOException</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getDiffUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiffUrl</h4>
<pre>public&nbsp;java.net.URL&nbsp;getDiffUrl()</pre>
<div class="block">The diff file,
like https://github.com/jenkinsci/jenkins/pull/100.diff</div>
</li>
</ul>
<a name="getMergedAt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMergedAt</h4>
<pre>public&nbsp;java.util.Date&nbsp;getMergedAt()</pre>
</li>
</ul>
<a name="getLabels--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabels</h4>
<pre>public&nbsp;java.util.Collection&lt;<a href="../../../org/kohsuke/github/GHLabel.html" title="class in org.kohsuke.github">GHLabel</a>&gt;&nbsp;getLabels()
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../org/kohsuke/github/GHIssue.html#getLabels--">getLabels</a></code>&nbsp;in class&nbsp;<code><a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getClosedBy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClosedBy</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a>&nbsp;getClosedBy()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../org/kohsuke/github/GHIssue.html#getClosedBy--">GHIssue</a></code></span></div>
<div class="block">Reports who has closed the issue.
<p>
Note that GitHub doesn't always seem to report this information
even for an issue that's already closed. See
https://github.com/kohsuke/github-api/issues/60.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../org/kohsuke/github/GHIssue.html#getClosedBy--">getClosedBy</a></code>&nbsp;in class&nbsp;<code><a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></code></dd>
</dl>
</li>
</ul>
<a name="getPullRequest--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPullRequest</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHIssue.PullRequest.html" title="class in org.kohsuke.github">GHIssue.PullRequest</a>&nbsp;getPullRequest()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../org/kohsuke/github/GHIssue.html#getPullRequest--">GHIssue</a></code></span></div>
<div class="block">Returns non-null if this issue is a shadow of a pull request.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../org/kohsuke/github/GHIssue.html#getPullRequest--">getPullRequest</a></code>&nbsp;in class&nbsp;<code><a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></code></dd>
</dl>
</li>
</ul>
<a name="getMergedBy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMergedBy</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a>&nbsp;getMergedBy()
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getReviewComments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReviewComments</h4>
<pre>public&nbsp;int&nbsp;getReviewComments()
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getAdditions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdditions</h4>
<pre>public&nbsp;int&nbsp;getAdditions()
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="isMerged--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMerged</h4>
<pre>public&nbsp;boolean&nbsp;isMerged()
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getMergeable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMergeable</h4>
<pre>public&nbsp;java.lang.Boolean&nbsp;getMergeable()
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getDeletions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeletions</h4>
<pre>public&nbsp;int&nbsp;getDeletions()
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getMergeableState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMergeableState</h4>
<pre>public&nbsp;java.lang.String&nbsp;getMergeableState()
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getChangedFiles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChangedFiles</h4>
<pre>public&nbsp;int&nbsp;getChangedFiles()
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getMergeCommitSha--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMergeCommitSha</h4>
<pre>public&nbsp;java.lang.String&nbsp;getMergeCommitSha()
throws java.io.IOException</pre>
<div class="block">See <a href="https://developer.github.com/changes/2013-04-25-deprecating-merge-commit-sha">GitHub blog post</a></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="listFiles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listFiles</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="../../../org/kohsuke/github/GHPullRequestFileDetail.html" title="class in org.kohsuke.github">GHPullRequestFileDetail</a>&gt;&nbsp;listFiles()</pre>
<div class="block">Retrieves all the commits associated to this pull request.</div>
</li>
</ul>
<a name="listReviewComments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listReviewComments</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="../../../org/kohsuke/github/GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a>&gt;&nbsp;listReviewComments()
throws java.io.IOException</pre>
<div class="block">Obtains all the review comments associated with this pull request.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="listCommits--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listCommits</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="../../../org/kohsuke/github/GHPullRequestCommitDetail.html" title="class in org.kohsuke.github">GHPullRequestCommitDetail</a>&gt;&nbsp;listCommits()</pre>
<div class="block">Retrieves all the commits associated to this pull request.</div>
</li>
</ul>
<a name="createReviewComment-java.lang.String-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createReviewComment</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a>&nbsp;createReviewComment(java.lang.String&nbsp;body,
java.lang.String&nbsp;sha,
java.lang.String&nbsp;path,
int&nbsp;position)
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="merge-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre>public&nbsp;void&nbsp;merge(java.lang.String&nbsp;msg)
throws java.io.IOException</pre>
<div class="block">Merge this pull request.
The equivalent of the big green "Merge pull request" button.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msg</code> - Commit message. If null, the default one will be used.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="merge-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>merge</h4>
<pre>public&nbsp;void&nbsp;merge(java.lang.String&nbsp;msg,
java.lang.String&nbsp;sha)
throws java.io.IOException</pre>
<div class="block">Merge this pull request.
The equivalent of the big green "Merge pull request" button.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msg</code> - Commit message. If null, the default one will be used.</dd>
<dd><code>sha</code> - SHA that pull request head must match to allow merge.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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 class="navBarCell1Rev">Class</li>
<li><a href="class-use/GHPullRequest.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><a href="../../../org/kohsuke/github/GHPersonSet.html" title="class in org.kohsuke.github"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/kohsuke/github/GHPullRequestCommitDetail.html" title="class in org.kohsuke.github"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/github/GHPullRequest.html" target="_top">Frames</a></li>
<li><a href="GHPullRequest.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.kohsuke.github.GHIssue">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.kohsuke.github.GHIssue">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016. All Rights Reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink