mirror of
https://github.com/jlengrand/github-api.git
synced 2026-05-08 15:52:17 +00:00
1366 lines
75 KiB
HTML
1366 lines
75 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (11.0.5) on Wed Apr 01 14:43:53 PDT 2020 -->
|
|
<title>GHPullRequest (GitHub API for Java 1.109 API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="dc.created" content="2020-04-01">
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../jquery/jquery-3.4.1.js"></script>
|
|
<script type="text/javascript" src="../../../jquery/jquery-ui.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.109 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10,"i1":10,"i2":42,"i3":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":42,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":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";
|
|
var pathtoroot = "../../../";
|
|
var useModuleDirectories = true;
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../index.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" id="allclasses_navbar_top">
|
|
<li><a href="../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<ul class="navListSearch">
|
|
<li><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<main role="main">
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.kohsuke.github</a></div>
|
|
<h2 title="Class GHPullRequest" class="title">Class GHPullRequest</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="GHObject.html" title="class in org.kohsuke.github">org.kohsuke.github.GHObject</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="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">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="Reactable.html" title="interface in org.kohsuke.github">Reactable</a></code>, <code><a href="Refreshable.html" title="interface in org.kohsuke.github">Refreshable</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">GHPullRequest</span>
|
|
extends <a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a>
|
|
implements <a href="Refreshable.html" title="interface in org.kohsuke.github">Refreshable</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="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 ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="nested.class.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Nested Class Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Class</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static class </code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="GHPullRequest.MergeMethod.html" title="enum in org.kohsuke.github">GHPullRequest.MergeMethod</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">The enum MergeMethod.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="nested.classes.inherited.from.class.org.kohsuke.github.GHIssue">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Nested classes/interfaces inherited from class org.kohsuke.github.<a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></h3>
|
|
<code><a href="GHIssue.PullRequest.html" title="class in org.kohsuke.github">GHIssue.PullRequest</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="fields.inherited.from.class.org.kohsuke.github.GHIssue">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from class org.kohsuke.github.<a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></h3>
|
|
<code><a href="GHIssue.html#assignee">assignee</a>, <a href="GHIssue.html#assignees">assignees</a>, <a href="GHIssue.html#body">body</a>, <a href="GHIssue.html#closed_at">closed_at</a>, <a href="GHIssue.html#closed_by">closed_by</a>, <a href="GHIssue.html#comments">comments</a>, <a href="GHIssue.html#html_url">html_url</a>, <a href="GHIssue.html#labels">labels</a>, <a href="GHIssue.html#locked">locked</a>, <a href="GHIssue.html#milestone">milestone</a>, <a href="GHIssue.html#number">number</a>, <a href="GHIssue.html#pull_request">pull_request</a>, <a href="GHIssue.html#state">state</a>, <a href="GHIssue.html#title">title</a>, <a href="GHIssue.html#user">user</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="fields.inherited.from.class.org.kohsuke.github.GHObject">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from class org.kohsuke.github.<a href="GHObject.html" title="class in org.kohsuke.github">GHObject</a></h3>
|
|
<code><a href="GHObject.html#created_at">created_at</a>, <a href="GHObject.html#id">id</a>, <a href="GHObject.html#responseHeaderFields">responseHeaderFields</a>, <a href="GHObject.html#updated_at">updated_at</a>, <a href="GHObject.html#url">url</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">GHPullRequest</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canMaintainerModify()">canMaintainerModify</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Can maintainer modify boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHPullRequestReviewBuilder.html" title="class in org.kohsuke.github">GHPullRequestReviewBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createReview()">createReview</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create review gh pull request review builder.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="GHPullRequestReview.html" title="class in org.kohsuke.github">GHPullRequestReview</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createReview(java.lang.String,org.kohsuke.github.GHPullRequestReviewState,java.util.List)">createReview</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> body,
|
|
<a href="GHPullRequestReviewState.html" title="enum in org.kohsuke.github">GHPullRequestReviewState</a> event,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a>> comments)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <a href="#createReview()"><code>createReview()</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHPullRequestReview.html" title="class in org.kohsuke.github">GHPullRequestReview</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createReview(java.lang.String,org.kohsuke.github.GHPullRequestReviewState,org.kohsuke.github.GHPullRequestReviewComment...)">createReview</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> body,
|
|
<a href="GHPullRequestReviewState.html" title="enum in org.kohsuke.github">GHPullRequestReviewState</a> event,
|
|
<a href="GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a>... comments)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <a href="#createReview()"><code>createReview()</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createReviewComment(java.lang.String,java.lang.String,java.lang.String,int)">createReviewComment</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> body,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sha,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path,
|
|
int position)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create review comment gh pull request review comment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAdditions()">getAdditions</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets additions.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getApiRoute()">getApiRoute</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets api route.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHCommitPointer.html" title="class in org.kohsuke.github">GHCommitPointer</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBase()">getBase</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<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="i8" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChangedFiles()">getChangedFiles</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets changed files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClosedBy()">getClosedBy</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Reports who has closed the issue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCommits()">getCommits</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets commits.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeletions()">getDeletions</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets deletions.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDiffUrl()">getDiffUrl</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">The diff file, like https://github.com/jenkinsci/jenkins/pull/100.diff</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHCommitPointer.html" title="class in org.kohsuke.github">GHCommitPointer</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHead()">getHead</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">The change that should be pulled.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIssueUpdatedAt()">getIssueUpdatedAt</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIssueUrl()">getIssueUrl</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">The URL of the patch file.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="GHLabel.html" title="class in org.kohsuke.github">GHLabel</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLabels()">getLabels</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets labels.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMergeable()">getMergeable</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Is this PR mergeable?</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMergeableState()">getMergeableState</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets mergeable state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMergeCommitSha()">getMergeCommitSha</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<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="i20" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMergedAt()">getMergedAt</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets merged at.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMergedBy()">getMergedBy</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets merged by.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPatchUrl()">getPatchUrl</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">The URL of the patch file.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHIssue.PullRequest.html" title="class in org.kohsuke.github">GHIssue.PullRequest</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPullRequest()">getPullRequest</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns non-null if this issue is a shadow of a pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestedReviewers()">getRequestedReviewers</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets requested reviewers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="GHTeam.html" title="class in org.kohsuke.github">GHTeam</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestedTeams()">getRequestedTeams</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets requested teams.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReviewComments()">getReviewComments</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets review comments.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDraft()">isDraft</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Is draft boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMerged()">isMerged</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Is merged boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHPullRequestCommitDetail.html" title="class in org.kohsuke.github">GHPullRequestCommitDetail</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listCommits()">listCommits</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves all the commits associated to this pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHPullRequestFileDetail.html" title="class in org.kohsuke.github">GHPullRequestFileDetail</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listFiles()">listFiles</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves all the files associated to this pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listReviewComments()">listReviewComments</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Obtains all the review comments associated with this pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHPullRequestReview.html" title="class in org.kohsuke.github">GHPullRequestReview</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listReviews()">listReviews</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves all the reviews associated to this pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i33" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#merge(java.lang.String)">merge</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> msg)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Merge this pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i34" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#merge(java.lang.String,java.lang.String)">merge</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> msg,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sha)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Merge this pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i35" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#merge(java.lang.String,java.lang.String,org.kohsuke.github.GHPullRequest.MergeMethod)">merge</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> msg,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sha,
|
|
<a href="GHPullRequest.MergeMethod.html" title="enum in org.kohsuke.github">GHPullRequest.MergeMethod</a> method)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Merge this pull request, using the specified merge method.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i36" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refresh()">refresh</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Repopulates this object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i37" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestReviewers(java.util.List)">requestReviewers</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> reviewers)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Request reviewers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i38" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestTeamReviewers(java.util.List)">requestTeamReviewers</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="GHTeam.html" title="class in org.kohsuke.github">GHTeam</a>> teams)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Request team reviewers.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.org.kohsuke.github.GHIssue">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class org.kohsuke.github.<a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></h3>
|
|
<code><a href="GHIssue.html#addAssignees(java.util.Collection)">addAssignees</a>, <a href="GHIssue.html#addAssignees(org.kohsuke.github.GHUser...)">addAssignees</a>, <a href="GHIssue.html#addLabels(java.lang.String...)">addLabels</a>, <a href="GHIssue.html#addLabels(java.util.Collection)">addLabels</a>, <a href="GHIssue.html#addLabels(org.kohsuke.github.GHLabel...)">addLabels</a>, <a href="GHIssue.html#assignTo(org.kohsuke.github.GHUser)">assignTo</a>, <a href="GHIssue.html#close()">close</a>, <a href="GHIssue.html#comment(java.lang.String)">comment</a>, <a href="GHIssue.html#createReaction(org.kohsuke.github.ReactionContent)">createReaction</a>, <a href="GHIssue.html#getApiURL()">getApiURL</a>, <a href="GHIssue.html#getAssignee()">getAssignee</a>, <a href="GHIssue.html#getAssignees()">getAssignees</a>, <a href="GHIssue.html#getBody()">getBody</a>, <a href="GHIssue.html#getClosedAt()">getClosedAt</a>, <a href="GHIssue.html#getComments()">getComments</a>, <a href="GHIssue.html#getCommentsCount()">getCommentsCount</a>, <a href="GHIssue.html#getHtmlUrl()">getHtmlUrl</a>, <a href="GHIssue.html#getIssuesApiRoute()">getIssuesApiRoute</a>, <a href="GHIssue.html#getLogins(java.util.Collection)">getLogins</a>, <a href="GHIssue.html#getMilestone()">getMilestone</a>, <a href="GHIssue.html#getNumber()">getNumber</a>, <a href="GHIssue.html#getRepository()">getRepository</a>, <a href="GHIssue.html#getState()">getState</a>, <a href="GHIssue.html#getTitle()">getTitle</a>, <a href="GHIssue.html#getUser()">getUser</a>, <a href="GHIssue.html#isLocked()">isLocked</a>, <a href="GHIssue.html#isPullRequest()">isPullRequest</a>, <a href="GHIssue.html#listComments()">listComments</a>, <a href="GHIssue.html#listEvents()">listEvents</a>, <a href="GHIssue.html#listReactions()">listReactions</a>, <a href="GHIssue.html#lock()">lock</a>, <a href="GHIssue.html#removeAssignees(java.util.Collection)">removeAssignees</a>, <a href="GHIssue.html#removeAssignees(org.kohsuke.github.GHUser...)">removeAssignees</a>, <a href="GHIssue.html#removeLabels(java.lang.String...)">removeLabels</a>, <a href="GHIssue.html#removeLabels(java.util.Collection)">removeLabels</a>, <a href="GHIssue.html#removeLabels(org.kohsuke.github.GHLabel...)">removeLabels</a>, <a href="GHIssue.html#reopen()">reopen</a>, <a href="GHIssue.html#setAssignees(java.util.Collection)">setAssignees</a>, <a href="GHIssue.html#setAssignees(org.kohsuke.github.GHUser...)">setAssignees</a>, <a href="GHIssue.html#setBody(java.lang.String)">setBody</a>, <a href="GHIssue.html#setLabels(java.lang.String...)">setLabels</a>, <a href="GHIssue.html#setMilestone(org.kohsuke.github.GHMilestone)">setMilestone</a>, <a href="GHIssue.html#setTitle(java.lang.String)">setTitle</a>, <a href="GHIssue.html#unlock()">unlock</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.org.kohsuke.github.GHObject">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class org.kohsuke.github.<a href="GHObject.html" title="class in org.kohsuke.github">GHObject</a></h3>
|
|
<code><a href="GHObject.html#getCreatedAt()">getCreatedAt</a>, <a href="GHObject.html#getId()">getId</a>, <a href="GHObject.html#getResponseHeaderFields()">getResponseHeaderFields</a>, <a href="GHObject.html#getUpdatedAt()">getUpdatedAt</a>, <a href="GHObject.html#getUrl()">getUrl</a>, <a href="GHObject.html#setResponseHeaderFields(org.kohsuke.github.GitHubResponse.ResponseInfo)">setResponseHeaderFields</a>, <a href="GHObject.html#toString()">toString</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.org.kohsuke.github.Refreshable">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from interface org.kohsuke.github.<a href="Refreshable.html" title="interface in org.kohsuke.github">Refreshable</a></h3>
|
|
<code><a href="Refreshable.html#refresh(java.lang.Object)">refresh</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a id="<init>()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>GHPullRequest</h4>
|
|
<pre>public GHPullRequest()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a id="getApiRoute()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getApiRoute</h4>
|
|
<pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getApiRoute()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="GHIssue.html#getApiRoute()">GHIssue</a></code></span></div>
|
|
<div class="block">Gets api route.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="GHIssue.html#getApiRoute()">getApiRoute</a></code> in class <code><a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the api route</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getPatchUrl()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPatchUrl</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a> getPatchUrl()</pre>
|
|
<div class="block">The URL of the patch file. like https://github.com/jenkinsci/jenkins/pull/100.patch</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the patch url</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getIssueUrl()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getIssueUrl</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a> getIssueUrl()</pre>
|
|
<div class="block">The URL of the patch file. like https://github.com/jenkinsci/jenkins/pull/100.patch</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the issue url</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getBase()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBase</h4>
|
|
<pre class="methodSignature">public <a href="GHCommitPointer.html" title="class in org.kohsuke.github">GHCommitPointer</a> 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>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the base</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getHead()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHead</h4>
|
|
<pre class="methodSignature">public <a href="GHCommitPointer.html" title="class in org.kohsuke.github">GHCommitPointer</a> getHead()</pre>
|
|
<div class="block">The change that should be pulled. The tip of the commits to merge.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the head</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getIssueUpdatedAt()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getIssueUpdatedAt</h4>
|
|
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
|
|
public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a> getIssueUpdatedAt()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
|
|
<div class="block">Gets issue updated at.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the issue updated at</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getDiffUrl()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDiffUrl</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a> getDiffUrl()</pre>
|
|
<div class="block">The diff file, like https://github.com/jenkinsci/jenkins/pull/100.diff</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the diff url</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMergedAt()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMergedAt</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a> getMergedAt()</pre>
|
|
<div class="block">Gets merged at.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the merged at</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getLabels()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLabels</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="GHLabel.html" title="class in org.kohsuke.github">GHLabel</a>> getLabels()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="GHIssue.html#getLabels()">GHIssue</a></code></span></div>
|
|
<div class="block">Gets labels.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="GHIssue.html#getLabels()">getLabels</a></code> in class <code><a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the labels</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getClosedBy()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getClosedBy</h4>
|
|
<pre class="methodSignature">public <a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a> getClosedBy()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="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="GHIssue.html#getClosedBy()">getClosedBy</a></code> in class <code><a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the closed by</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getPullRequest()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPullRequest</h4>
|
|
<pre class="methodSignature">public <a href="GHIssue.PullRequest.html" title="class in org.kohsuke.github">GHIssue.PullRequest</a> getPullRequest()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="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="GHIssue.html#getPullRequest()">getPullRequest</a></code> in class <code><a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the pull request</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMergedBy()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMergedBy</h4>
|
|
<pre class="methodSignature">public <a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a> getMergedBy()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Gets merged by.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the merged by</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getReviewComments()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReviewComments</h4>
|
|
<pre class="methodSignature">public int getReviewComments()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Gets review comments.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the review comments</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getAdditions()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAdditions</h4>
|
|
<pre class="methodSignature">public int getAdditions()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Gets additions.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the additions</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getCommits()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCommits</h4>
|
|
<pre class="methodSignature">public int getCommits()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Gets commits.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the commits</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isMerged()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isMerged</h4>
|
|
<pre class="methodSignature">public boolean isMerged()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Is merged boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="canMaintainerModify()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>canMaintainerModify</h4>
|
|
<pre class="methodSignature">public boolean canMaintainerModify()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Can maintainer modify boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isDraft()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isDraft</h4>
|
|
<pre class="methodSignature">public boolean isDraft()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Is draft boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMergeable()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMergeable</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a> getMergeable()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Is this PR mergeable?</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>null if the state has not been determined yet, for example when a PR is newly created. If this method is
|
|
called on an instance whose mergeable state is not yet known, API call is made to retrieve the latest
|
|
state.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getDeletions()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDeletions</h4>
|
|
<pre class="methodSignature">public int getDeletions()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Gets deletions.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the deletions</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMergeableState()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMergeableState</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getMergeableState()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Gets mergeable state.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the mergeable state</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getChangedFiles()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getChangedFiles</h4>
|
|
<pre class="methodSignature">public int getChangedFiles()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Gets changed files.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the changed files</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMergeCommitSha()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMergeCommitSha</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getMergeCommitSha()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></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="returnLabel">Returns:</span></dt>
|
|
<dd>the merge commit sha</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getRequestedReviewers()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRequestedReviewers</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> getRequestedReviewers()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Gets requested reviewers.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the requested reviewers</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getRequestedTeams()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRequestedTeams</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="GHTeam.html" title="class in org.kohsuke.github">GHTeam</a>> getRequestedTeams()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Gets requested teams.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the requested teams</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="refresh()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>refresh</h4>
|
|
<pre class="methodSignature">public void refresh()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Repopulates this object.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Refreshable.html#refresh()">refresh</a></code> in interface <code><a href="Refreshable.html" title="interface in org.kohsuke.github">Refreshable</a></code></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listFiles()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listFiles</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHPullRequestFileDetail.html" title="class in org.kohsuke.github">GHPullRequestFileDetail</a>> listFiles()</pre>
|
|
<div class="block">Retrieves all the files associated to this pull request.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listReviews()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listReviews</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHPullRequestReview.html" title="class in org.kohsuke.github">GHPullRequestReview</a>> listReviews()</pre>
|
|
<div class="block">Retrieves all the reviews associated to this pull request.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listReviewComments()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listReviewComments</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a>> listReviewComments()
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Obtains all the review comments associated with this pull request.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listCommits()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listCommits</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHPullRequestCommitDetail.html" title="class in org.kohsuke.github">GHPullRequestCommitDetail</a>> listCommits()</pre>
|
|
<div class="block">Retrieves all the commits associated to this pull request.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createReview(java.lang.String,org.kohsuke.github.GHPullRequestReviewState,org.kohsuke.github.GHPullRequestReviewComment...)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createReview</h4>
|
|
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
|
|
public <a href="GHPullRequestReview.html" title="class in org.kohsuke.github">GHPullRequestReview</a> createReview​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> body,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/CheckForNull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@CheckForNull</a>
|
|
<a href="GHPullRequestReviewState.html" title="enum in org.kohsuke.github">GHPullRequestReviewState</a> event,
|
|
<a href="GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a>... comments)
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <a href="#createReview()"><code>createReview()</code></a></div>
|
|
</div>
|
|
<div class="block">Create review gh pull request review.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>body</code> - the body</dd>
|
|
<dd><code>event</code> - the event</dd>
|
|
<dd><code>comments</code> - the comments</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh pull request review</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createReview(java.lang.String,org.kohsuke.github.GHPullRequestReviewState,java.util.List)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createReview</h4>
|
|
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
|
|
public <a href="GHPullRequestReview.html" title="class in org.kohsuke.github">GHPullRequestReview</a> createReview​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> body,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/CheckForNull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@CheckForNull</a>
|
|
<a href="GHPullRequestReviewState.html" title="enum in org.kohsuke.github">GHPullRequestReviewState</a> event,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a>> comments)
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <a href="#createReview()"><code>createReview()</code></a></div>
|
|
</div>
|
|
<div class="block">Create review gh pull request review.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>body</code> - the body</dd>
|
|
<dd><code>event</code> - the event</dd>
|
|
<dd><code>comments</code> - the comments</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh pull request review</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createReview()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createReview</h4>
|
|
<pre class="methodSignature">public <a href="GHPullRequestReviewBuilder.html" title="class in org.kohsuke.github">GHPullRequestReviewBuilder</a> createReview()</pre>
|
|
<div class="block">Create review gh pull request review builder.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh pull request review builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createReviewComment(java.lang.String,java.lang.String,java.lang.String,int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createReviewComment</h4>
|
|
<pre class="methodSignature">public <a href="GHPullRequestReviewComment.html" title="class in org.kohsuke.github">GHPullRequestReviewComment</a> createReviewComment​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> body,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sha,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path,
|
|
int position)
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Create review comment gh pull request review comment.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>body</code> - the body</dd>
|
|
<dd><code>sha</code> - the sha</dd>
|
|
<dd><code>path</code> - the path</dd>
|
|
<dd><code>position</code> - the position</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh pull request review comment</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="requestReviewers(java.util.List)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>requestReviewers</h4>
|
|
<pre class="methodSignature">public void requestReviewers​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> reviewers)
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Request reviewers.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>reviewers</code> - the reviewers</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="requestTeamReviewers(java.util.List)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>requestTeamReviewers</h4>
|
|
<pre class="methodSignature">public void requestTeamReviewers​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="GHTeam.html" title="class in org.kohsuke.github">GHTeam</a>> teams)
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Request team reviewers.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>teams</code> - the teams</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="merge(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>merge</h4>
|
|
<pre class="methodSignature">public void merge​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> msg)
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Merge this pull request.
|
|
<p>
|
|
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><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="merge(java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>merge</h4>
|
|
<pre class="methodSignature">public void merge​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> msg,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sha)
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Merge this pull request.
|
|
<p>
|
|
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><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="merge(java.lang.String,java.lang.String,org.kohsuke.github.GHPullRequest.MergeMethod)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>merge</h4>
|
|
<pre class="methodSignature">public void merge​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> msg,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sha,
|
|
<a href="GHPullRequest.MergeMethod.html" title="enum in org.kohsuke.github">GHPullRequest.MergeMethod</a> method)
|
|
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
|
|
<div class="block">Merge this pull request, using the specified merge method.
|
|
<p>
|
|
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> - the sha</dd>
|
|
<dd><code>method</code> - SHA that pull request head must match to allow merge.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../index.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" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../allclasses.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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
<p class="legalCopy"><small>Copyright © 2020. All rights reserved.</small></p>
|
|
</footer>
|
|
</body>
|
|
</html>
|