mirror of
https://github.com/jlengrand/github-api.git
synced 2026-05-08 15:52:17 +00:00
4692 lines
274 KiB
HTML
4692 lines
274 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (11.0.5) on Wed Nov 27 10:38:59 PST 2019 -->
|
|
<title>GHRepository (GitHub API for Java 1.101 API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="dc.created" content="2019-11-27">
|
|
<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="GHRepository (GitHub API for Java 1.101 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":42,"i13":42,"i14":42,"i15":42,"i16":10,"i17":42,"i18":10,"i19":10,"i20":10,"i21":42,"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,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":42,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":42,"i77":10,"i78":42,"i79":10,"i80":10,"i81":42,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":42,"i89":10,"i90":10,"i91":10,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10,"i98":42,"i99":10,"i100":10,"i101":10,"i102":10,"i103":10,"i104":10,"i105":10,"i106":10,"i107":10,"i108":10,"i109":10,"i110":10,"i111":10,"i112":10,"i113":42,"i114":10,"i115":10,"i116":10,"i117":10,"i118":10,"i119":10,"i120":10,"i121":10,"i122":10,"i123":10,"i124":10,"i125":10,"i126":10,"i127":10,"i128":10,"i129":10,"i130":10,"i131":10,"i132":10,"i133":10,"i134":10,"i135":10,"i136":10,"i137":10,"i138":10,"i139":10,"i140":10,"i141":10,"i142":10,"i143":10,"i144":10,"i145":10,"i146":10,"i147":10,"i148":42,"i149":10,"i150":10,"i151":10,"i152":10,"i153":10,"i154":10,"i155":10,"i156":10,"i157":10,"i158":10,"i159":10,"i160":10,"i161":10,"i162":10,"i163":10,"i164":10,"i165":10,"i166":10,"i167":10,"i168":10,"i169":10,"i170":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/GHRepository.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 GHRepository" class="title">Class GHRepository</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>org.kohsuke.github.GHRepository</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">GHRepository</span>
|
|
extends <a href="GHObject.html" title="class in org.kohsuke.github">GHObject</a></pre>
|
|
<div class="block">A repository on GitHub.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
|
<dd>Kohsuke Kawaguchi</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="GHRepository.Contributor.html" title="class in org.kohsuke.github">GHRepository.Contributor</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">The type Contributor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static class </code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="GHRepository.ForkSort.html" title="enum in org.kohsuke.github">GHRepository.ForkSort</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sort orders for listing forks</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</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.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()">GHRepository</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>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addCollaborators(java.util.Collection)">addCollaborators</a></span>​(<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="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> users)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Add collaborators.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addCollaborators(org.kohsuke.github.GHUser...)">addCollaborators</a></span>​(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>... users)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Add collaborators.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="GHDeployKey.html" title="class in org.kohsuke.github">GHDeployKey</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDeployKey(java.lang.String,java.lang.String)">addDeployKey</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> title,
|
|
<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> key)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Add deploy key gh deploy key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowMergeCommit(boolean)">allowMergeCommit</a></span>​(boolean value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Allow merge commit.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowRebaseMerge(boolean)">allowRebaseMerge</a></span>​(boolean value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Allow rebase merge.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowSquashMerge(boolean)">allowSquashMerge</a></span>​(boolean value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Allow squash merge.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#archive()">archive</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Will archive and this repository as read-only.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHBlobBuilder.html" title="class in org.kohsuke.github">GHBlobBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createBlob()">createBlob</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create blob gh blob builder.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><a href="GHCommitBuilder.html" title="class in org.kohsuke.github">GHCommitBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCommit()">createCommit</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create commit gh commit builder.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHCommitStatus.html" title="class in org.kohsuke.github">GHCommitStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCommitStatus(java.lang.String,org.kohsuke.github.GHCommitState,java.lang.String,java.lang.String)">createCommitStatus</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> sha1,
|
|
<a href="GHCommitState.html" title="enum in org.kohsuke.github">GHCommitState</a> state,
|
|
<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> targetUrl,
|
|
<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> description)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create commit status gh commit status.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code><a href="GHCommitStatus.html" title="class in org.kohsuke.github">GHCommitStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCommitStatus(java.lang.String,org.kohsuke.github.GHCommitState,java.lang.String,java.lang.String,java.lang.String)">createCommitStatus</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> sha1,
|
|
<a href="GHCommitState.html" title="enum in org.kohsuke.github">GHCommitState</a> state,
|
|
<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> targetUrl,
|
|
<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> description,
|
|
<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> context)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a commit status</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHContentBuilder.html" title="class in org.kohsuke.github">GHContentBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createContent()">createContent</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a new content, or update an existing content.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code><a href="GHContentUpdateResponse.html" title="class in org.kohsuke.github">GHContentUpdateResponse</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createContent(byte%5B%5D,java.lang.String,java.lang.String)">createContent</a></span>​(byte[] contentBytes,
|
|
<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> commitMessage,
|
|
<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)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHContentUpdateResponse.html" title="class in org.kohsuke.github">GHContentUpdateResponse</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createContent(byte%5B%5D,java.lang.String,java.lang.String,java.lang.String)">createContent</a></span>​(byte[] contentBytes,
|
|
<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> commitMessage,
|
|
<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,
|
|
<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> branch)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code><a href="GHContentUpdateResponse.html" title="class in org.kohsuke.github">GHContentUpdateResponse</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createContent(java.lang.String,java.lang.String,java.lang.String)">createContent</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> content,
|
|
<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> commitMessage,
|
|
<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)</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="GHContentUpdateResponse.html" title="class in org.kohsuke.github">GHContentUpdateResponse</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createContent(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">createContent</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> content,
|
|
<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> commitMessage,
|
|
<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,
|
|
<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> branch)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code><a href="GHDeploymentBuilder.html" title="class in org.kohsuke.github">GHDeploymentBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createDeployment(java.lang.String)">createDeployment</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> ref)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create deployment gh deployment builder.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHDeploymentStatusBuilder.html" title="class in org.kohsuke.github">GHDeploymentStatusBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createDeployStatus(int,org.kohsuke.github.GHDeploymentState)">createDeployStatus</a></span>​(int deploymentId,
|
|
<a href="GHDeploymentState.html" title="enum in org.kohsuke.github">GHDeploymentState</a> ghDeploymentState)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <code>getDeployment(deploymentId).createStatus(ghDeploymentState)</code></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code><a href="GHHook.html" title="class in org.kohsuke.github">GHHook</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createHook(java.lang.String,java.util.Map,java.util.Collection,boolean)">createHook</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> name,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<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>,​<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>> config,
|
|
<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="GHEvent.html" title="enum in org.kohsuke.github">GHEvent</a>> events,
|
|
boolean active)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">See https://api.github.com/hooks for possible names and their configuration scheme.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHIssueBuilder.html" title="class in org.kohsuke.github">GHIssueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createIssue(java.lang.String)">createIssue</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> title)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create issue gh issue builder.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code><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="#createLabel(java.lang.String,java.lang.String)">createLabel</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> name,
|
|
<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> color)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create label gh label.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code><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="#createLabel(java.lang.String,java.lang.String,java.lang.String)">createLabel</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> name,
|
|
<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> color,
|
|
<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> description)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code><a href="GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createMilestone(java.lang.String,java.lang.String)">createMilestone</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> title,
|
|
<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> description)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create milestone gh milestone.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHProject.html" title="class in org.kohsuke.github">GHProject</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createProject(java.lang.String,java.lang.String)">createProject</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> name,
|
|
<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)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create a project for this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code><a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPullRequest(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">createPullRequest</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> title,
|
|
<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> head,
|
|
<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> base,
|
|
<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)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a new pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPullRequest(java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean)">createPullRequest</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> title,
|
|
<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> head,
|
|
<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> base,
|
|
<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,
|
|
boolean maintainerCanModify)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a new pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code><a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPullRequest(java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean,boolean)">createPullRequest</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> title,
|
|
<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> head,
|
|
<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> base,
|
|
<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,
|
|
boolean maintainerCanModify,
|
|
boolean draft)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a new pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRef(java.lang.String,java.lang.String)">createRef</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> name,
|
|
<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">Creates a named ref, such as tag, branch, etc.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code><a href="GHReleaseBuilder.html" title="class in org.kohsuke.github">GHReleaseBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRelease(java.lang.String)">createRelease</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> tag)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create release gh release builder.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHTreeBuilder.html" title="class in org.kohsuke.github">GHTreeBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createTree()">createTree</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create tree gh tree builder.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code><a href="GHHook.html" title="class in org.kohsuke.github">GHHook</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createWebHook(java.net.URL)">createWebHook</a></span>​(<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> url)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create web hook gh hook.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHHook.html" title="class in org.kohsuke.github">GHHook</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createWebHook(java.net.URL,java.util.Collection)">createWebHook</a></span>​(<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> url,
|
|
<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="GHEvent.html" title="enum in org.kohsuke.github">GHEvent</a>> events)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create web hook gh hook.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete()">delete</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Deletes this repository.</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="#enableDownloads(boolean)">enableDownloads</a></span>​(boolean v)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Enable downloads.</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="#enableIssueTracker(boolean)">enableIssueTracker</a></span>​(boolean v)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Enables or disables the issue tracker for this repository.</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="#enableWiki(boolean)">enableWiki</a></span>​(boolean v)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Enables or disables Wiki for this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i36" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<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> obj)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i37" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fork()">fork</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Forks this repository as your repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i38" class="altColor">
|
|
<td class="colFirst"><code><a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forkTo(org.kohsuke.github.GHOrganization)">forkTo</a></span>​(<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a> org)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Forks this repository into an organization.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i39" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHBlob.html" title="class in org.kohsuke.github">GHBlob</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBlob(java.lang.String)">getBlob</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> blobSha)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Obtains the metadata & the content of a blob.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i40" class="altColor">
|
|
<td class="colFirst"><code><a href="GHBranch.html" title="class in org.kohsuke.github">GHBranch</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBranch(java.lang.String)">getBranch</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> name)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets branch.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i41" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<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>,​<a href="GHBranch.html" title="class in org.kohsuke.github">GHBranch</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBranches()">getBranches</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets branches by <a href="GHBranch.html#getName()">their names</a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i42" class="altColor">
|
|
<td class="colFirst"><code><a href="GHRepositoryCloneTraffic.html" title="class in org.kohsuke.github">GHRepositoryCloneTraffic</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCloneTraffic()">getCloneTraffic</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><a href="https://developer.github.com/v3/repos/traffic/#clones">https://developer.github.com/v3/repos/traffic/#clones</a></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i43" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<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="#getCollaboratorNames()">getCollaboratorNames</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the names of the collaborators on this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i44" class="altColor">
|
|
<td class="colFirst"><code><a href="GHPersonSet.html" title="class in org.kohsuke.github">GHPersonSet</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="#getCollaborators()">getCollaborators</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the collaborators on this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i45" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHCommit.html" title="class in org.kohsuke.github">GHCommit</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCommit(java.lang.String)">getCommit</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> sha1)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets a commit object in this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i46" class="altColor">
|
|
<td class="colFirst"><code><a href="GHCompare.html" title="class in org.kohsuke.github">GHCompare</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompare(java.lang.String,java.lang.String)">getCompare</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> id1,
|
|
<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> id2)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets a comparison between 2 points in the repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i47" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHCompare.html" title="class in org.kohsuke.github">GHCompare</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompare(org.kohsuke.github.GHBranch,org.kohsuke.github.GHBranch)">getCompare</a></span>​(<a href="GHBranch.html" title="class in org.kohsuke.github">GHBranch</a> id1,
|
|
<a href="GHBranch.html" title="class in org.kohsuke.github">GHBranch</a> id2)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets compare.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i48" class="altColor">
|
|
<td class="colFirst"><code><a href="GHCompare.html" title="class in org.kohsuke.github">GHCompare</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompare(org.kohsuke.github.GHCommit,org.kohsuke.github.GHCommit)">getCompare</a></span>​(<a href="GHCommit.html" title="class in org.kohsuke.github">GHCommit</a> id1,
|
|
<a href="GHCommit.html" title="class in org.kohsuke.github">GHCommit</a> id2)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets compare.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i49" 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="#getDefaultBranch()">getDefaultBranch</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the primary branch you'll configure in the "Admin > Options" config page.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i50" 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="GHDeployKey.html" title="class in org.kohsuke.github">GHDeployKey</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeployKeys()">getDeployKeys</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets deploy keys.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i51" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHDeployment.html" title="class in org.kohsuke.github">GHDeployment</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeployment(long)">getDeployment</a></span>​(long id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Obtains a single <a href="GHDeployment.html" title="class in org.kohsuke.github"><code>GHDeployment</code></a> by its ID.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i52" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHDeploymentStatus.html" title="class in org.kohsuke.github">GHDeploymentStatus</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeploymentStatuses(int)">getDeploymentStatuses</a></span>​(int id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <code>getDeployment(id).listStatuses()</code></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i53" 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="#getDescription()">getDescription</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets description.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i54" 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="GHContent.html" title="class in org.kohsuke.github">GHContent</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDirectoryContent(java.lang.String)">getDirectoryContent</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> path)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets directory content.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i55" 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="GHContent.html" title="class in org.kohsuke.github">GHContent</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDirectoryContent(java.lang.String,java.lang.String)">getDirectoryContent</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> path,
|
|
<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> ref)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets directory content.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i56" class="altColor">
|
|
<td class="colFirst"><code><a href="GHContent.html" title="class in org.kohsuke.github">GHContent</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileContent(java.lang.String)">getFileContent</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> path)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets file content.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i57" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHContent.html" title="class in org.kohsuke.github">GHContent</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileContent(java.lang.String,java.lang.String)">getFileContent</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> path,
|
|
<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> ref)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets file content.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i58" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getForks()">getForks</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the number of all forks of this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i59" 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="#getFullName()">getFullName</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Full repository name including the owner or organization.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i60" 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="#getGitTransportUrl()">getGitTransportUrl</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the git:// URL to this repository, such as "git://github.com/kohsuke/jenkins.git" This URL is read-only.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i61" 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="#getHomepage()">getHomepage</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets homepage.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i62" class="altColor">
|
|
<td class="colFirst"><code><a href="GHHook.html" title="class in org.kohsuke.github">GHHook</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHook(int)">getHook</a></span>​(int id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets hook.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i63" 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="GHHook.html" title="class in org.kohsuke.github">GHHook</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHooks()">getHooks</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves the currently configured hooks.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i64" 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="#getHtmlUrl()">getHtmlUrl</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets html url.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i65" 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="#getHttpTransportUrl()">getHttpTransportUrl</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the HTTPS URL to this repository, such as "https://github.com/kohsuke/jenkins.git" This URL is read-only.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i66" class="altColor">
|
|
<td class="colFirst"><code><a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIssue(int)">getIssue</a></span>​(int id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets issue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i67" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHIssueEvent.html" title="class in org.kohsuke.github">GHIssueEvent</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIssueEvent(long)">getIssueEvent</a></span>​(long id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get a single issue event.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i68" 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="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIssues(org.kohsuke.github.GHIssueState)">getIssues</a></span>​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets issues.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i69" 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="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIssues(org.kohsuke.github.GHIssueState,org.kohsuke.github.GHMilestone)">getIssues</a></span>​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state,
|
|
<a href="GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a> milestone)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets issues.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i70" class="altColor">
|
|
<td class="colFirst"><code><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="#getLabel(java.lang.String)">getLabel</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> name)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets label.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i71" 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="#getLanguage()">getLanguage</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the primary programming language.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i72" class="altColor">
|
|
<td class="colFirst"><code><a href="GHCommitStatus.html" title="class in org.kohsuke.github">GHCommitStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLastCommitStatus(java.lang.String)">getLastCommitStatus</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> sha1)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the last status of this commit, which is what gets shown in the UI.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i73" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHRelease.html" title="class in org.kohsuke.github">GHRelease</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLatestRelease()">getLatestRelease</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets latest release.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i74" class="altColor">
|
|
<td class="colFirst"><code><a href="GHLicense.html" title="class in org.kohsuke.github">GHLicense</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLicense()">getLicense</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the basic license details for the repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i75" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHContent.html" title="class in org.kohsuke.github">GHContent</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLicenseContent()">getLicenseContent</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves the contents of the repository's license file - makes an additional API call</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i76" 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="#getMasterBranch()">getMasterBranch</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Renamed to <a href="#getDefaultBranch()"><code>getDefaultBranch()</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i77" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMilestone(int)">getMilestone</a></span>​(int number)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets milestone.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i78" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMilestones()">getMilestones</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <a href="#listMilestones(org.kohsuke.github.GHIssueState)"><code>listMilestones(GHIssueState)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i79" 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="#getMirrorUrl()">getMirrorUrl</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the Mirror URL to access this repository: https://github.com/apache/tomee mirrored from
|
|
git://git.apache.org/tomee.git</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i80" 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="#getName()">getName</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Short repository name without the owner.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i81" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNetworkCount()">getNetworkCount</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">This no longer exists in the official API documentation.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i82" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOpenIssueCount()">getOpenIssueCount</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets open issue count.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i83" 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="#getOwner()">getOwner</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets owner.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i84" 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="#getOwnerName()">getOwnerName</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets owner name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i85" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParent()">getParent</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Forked repositories have a 'parent' attribute that specifies the repository this repository is directly forked
|
|
from.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i86" class="altColor">
|
|
<td class="colFirst"><code><a href="GHPermissionType.html" title="enum in org.kohsuke.github">GHPermissionType</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPermission(java.lang.String)">getPermission</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> user)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Obtain permission for a given user in this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i87" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHPermissionType.html" title="enum in org.kohsuke.github">GHPermissionType</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPermission(org.kohsuke.github.GHUser)">getPermission</a></span>​(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a> u)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Obtain permission for a given user in this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i88" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<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="#getPostCommitHooks()">getPostCommitHooks</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <a href="#getHooks()"><code>getHooks()</code></a> and <a href="#createHook(java.lang.String,java.util.Map,java.util.Collection,boolean)"><code>createHook(String, Map, Collection, boolean)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i89" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPullRequest(int)">getPullRequest</a></span>​(int i)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves a specified pull request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i90" 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="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPullRequests(org.kohsuke.github.GHIssueState)">getPullRequests</a></span>​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves all the pull requests of a particular state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i91" class="rowColor">
|
|
<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="#getPushedAt()">getPushedAt</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets pushed at.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i92" class="altColor">
|
|
<td class="colFirst"><code><a href="GHContent.html" title="class in org.kohsuke.github">GHContent</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReadme()">getReadme</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">https://developer.github.com/v3/repos/contents/#get-the-readme</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i93" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRef(java.lang.String)">getRef</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> refName)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrive a ref of the given type for the current GitHub repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i94" class="altColor">
|
|
<td class="colFirst"><code><a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRefs()">getRefs</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves all refs for the github repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i95" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRefs(java.lang.String)">getRefs</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> refType)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves all refs of the given type for the current GitHub repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i96" class="altColor">
|
|
<td class="colFirst"><code><a href="GHRelease.html" title="class in org.kohsuke.github">GHRelease</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelease(long)">getRelease</a></span>​(long id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets release.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i97" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHRelease.html" title="class in org.kohsuke.github">GHRelease</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReleaseByTagName(java.lang.String)">getReleaseByTagName</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> tag)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets release by tag name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i98" 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="GHRelease.html" title="class in org.kohsuke.github">GHRelease</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReleases()">getReleases</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">use <a href="#listReleases()"><code>listReleases()</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i99" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSize()">getSize</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets size.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i100" class="altColor">
|
|
<td class="colFirst"><code><a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSource()">getSource</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Forked repositories have a 'source' attribute that specifies the ultimate source of the forking chain.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i101" 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="#getSshUrl()">getSshUrl</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the SSH URL to access this repository, such as git@github.com:rails/rails.git</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i102" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStargazersCount()">getStargazersCount</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets stargazers count.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i103" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHRepositoryStatistics.html" title="class in org.kohsuke.github">GHRepositoryStatistics</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatistics()">getStatistics</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the statistics for this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i104" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubscribersCount()">getSubscribersCount</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets subscribers count.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i105" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHSubscription.html" title="class in org.kohsuke.github">GHSubscription</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubscription()">getSubscription</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the current subscription.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i106" 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="#getSvnUrl()">getSvnUrl</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the Subversion URL to access this repository: https://github.com/rails/rails</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i107" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHTagObject.html" title="class in org.kohsuke.github">GHTagObject</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTagObject(java.lang.String)">getTagObject</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> sha)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the <strong>annotated</strong> tag object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i108" class="altColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</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="#getTeams()">getTeams</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">If this repository belongs to an organization, return a set of teams.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i109" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHTree.html" title="class in org.kohsuke.github">GHTree</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTree(java.lang.String)">getTree</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> sha)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrive a tree of the given type for the current GitHub repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i110" class="altColor">
|
|
<td class="colFirst"><code><a href="GHTree.html" title="class in org.kohsuke.github">GHTree</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTreeRecursive(java.lang.String,int)">getTreeRecursive</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> sha,
|
|
int recursive)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves the tree for the current GitHub repository, recursively as described in here:
|
|
https://developer.github.com/v3/git/trees/#get-a-tree-recursively</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i111" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHRepositoryViewTraffic.html" title="class in org.kohsuke.github">GHRepositoryViewTraffic</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getViewTraffic()">getViewTraffic</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><a href="https://developer.github.com/v3/repos/traffic/#views">https://developer.github.com/v3/repos/traffic/#views</a></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i112" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWatchers()">getWatchers</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets watchers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i113" 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="#gitHttpTransportUrl()">gitHttpTransportUrl</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Typo of <a href="#getHttpTransportUrl()"><code>getHttpTransportUrl()</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i114" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasAdminAccess()">hasAdminAccess</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Has admin access boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i115" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasAssignee(org.kohsuke.github.GHUser)">hasAssignee</a></span>​(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a> u)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Checks if the given user is an assignee for this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i116" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasDownloads()">hasDownloads</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Has downloads boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i117" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i118" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasIssues()">hasIssues</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Has issues boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i119" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPages()">hasPages</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Has pages boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i120" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPullAccess()">hasPullAccess</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Has pull access boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i121" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPushAccess()">hasPushAccess</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Has push access boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i122" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasWiki()">hasWiki</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Has wiki boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i123" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAllowMergeCommit()">isAllowMergeCommit</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Is allow merge commit boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i124" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAllowRebaseMerge()">isAllowRebaseMerge</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Is allow rebase merge boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i125" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAllowSquashMerge()">isAllowSquashMerge</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Is allow squash merge boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i126" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isArchived()">isArchived</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Is archived boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i127" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFork()">isFork</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Is fork boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i128" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPrivate()">isPrivate</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Is private boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i129" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</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="#listAssignees()">listAssignees</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists all
|
|
<a href="https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/">the
|
|
available assignees</a> to which issues may be assigned.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i130" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</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="#listCollaborators()">listCollaborators</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists up the collaborators on this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i131" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHCommitComment.html" title="class in org.kohsuke.github">GHCommitComment</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listCommitComments()">listCommitComments</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists up all the commit comments in this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i132" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHCommit.html" title="class in org.kohsuke.github">GHCommit</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">Lists all the commits.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i133" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHCommitStatus.html" title="class in org.kohsuke.github">GHCommitStatus</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listCommitStatuses(java.lang.String)">listCommitStatuses</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> sha1)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">/** Lists all the commit statues attached to the given commit, newer ones first.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i134" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRepository.Contributor.html" title="class in org.kohsuke.github">GHRepository.Contributor</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listContributors()">listContributors</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">List contributors paged iterable.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i135" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHDeployment.html" title="class in org.kohsuke.github">GHDeployment</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listDeployments(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">listDeployments</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> 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> ref,
|
|
<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> task,
|
|
<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> environment)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">List deployments paged iterable.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i136" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHEventInfo.html" title="class in org.kohsuke.github">GHEventInfo</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listEvents()">listEvents</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists repository events.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i137" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listForks()">listForks</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists all the direct forks of this repository, sorted by github api default, currently <a href="GHRepository.ForkSort.html#NEWEST"><code>ForkSort.NEWEST</code></a>*.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i138" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listForks(org.kohsuke.github.GHRepository.ForkSort)">listForks</a></span>​(<a href="GHRepository.ForkSort.html" title="enum in org.kohsuke.github">GHRepository.ForkSort</a> sort)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists all the direct forks of this repository, sorted by the given sort order.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i139" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHInvitation.html" title="class in org.kohsuke.github">GHInvitation</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listInvitations()">listInvitations</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists all the invitations.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i140" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHIssueEvent.html" title="class in org.kohsuke.github">GHIssueEvent</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listIssueEvents()">listIssueEvents</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get all issue events for this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i141" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listIssues(org.kohsuke.github.GHIssueState)">listIssues</a></span>​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists up all the issues in this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i142" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</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="#listLabels()">listLabels</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists labels in this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i143" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<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>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listLanguages()">listLanguages</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">List languages for the specified repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i144" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listMilestones(org.kohsuke.github.GHIssueState)">listMilestones</a></span>​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists up all the milestones in this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i145" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listNotifications()">listNotifications</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">List all the notifications in a repository for the current user.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i146" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHProject.html" title="class in org.kohsuke.github">GHProject</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listProjects()">listProjects</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns open projects for this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i147" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHProject.html" title="class in org.kohsuke.github">GHProject</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listProjects(org.kohsuke.github.GHProject.ProjectStateFilter)">listProjects</a></span>​(<a href="GHProject.ProjectStateFilter.html" title="enum in org.kohsuke.github">GHProject.ProjectStateFilter</a> status)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the projects for this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i148" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listPullRequests(org.kohsuke.github.GHIssueState)">listPullRequests</a></span>​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <a href="#queryPullRequests()"><code>queryPullRequests()</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i149" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listRefs()">listRefs</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves all refs for the github repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i150" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listRefs(java.lang.String)">listRefs</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> refType)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves all refs of the given type for the current GitHub repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i151" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRelease.html" title="class in org.kohsuke.github">GHRelease</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listReleases()">listReleases</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">List releases paged iterable.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i152" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</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="#listStargazers()">listStargazers</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists all the users who have starred this repo based on the old version of the API.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i153" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHStargazer.html" title="class in org.kohsuke.github">GHStargazer</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listStargazers2()">listStargazers2</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists all the users who have starred this repo based on new version of the API, having extended information like
|
|
the time when the repository was starred.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i154" class="altColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</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="#listSubscribers()">listSubscribers</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lists all the subscribers (aka watchers.)</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i155" class="rowColor">
|
|
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHTag.html" title="class in org.kohsuke.github">GHTag</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listTags()">listTags</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">List tags paged iterable.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i156" 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="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="#listTopics()">listTopics</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the topics for this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i157" class="rowColor">
|
|
<td class="colFirst"><code><a href="GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryCommits()">queryCommits</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Search commits by specifying filters through a builder pattern.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i158" class="altColor">
|
|
<td class="colFirst"><code><a href="GHPullRequestQueryBuilder.html" title="class in org.kohsuke.github">GHPullRequestQueryBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryPullRequests()">queryPullRequests</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieves pull requests.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i159" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readBlob(java.lang.String)">readBlob</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> blobSha)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Reads the content of a blob as a stream for better efficiency.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i160" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeCollaborators(java.util.Collection)">removeCollaborators</a></span>​(<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="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> users)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Remove collaborators.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i161" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeCollaborators(org.kohsuke.github.GHUser...)">removeCollaborators</a></span>​(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>... users)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Remove collaborators.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i162" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renameTo(java.lang.String)">renameTo</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> name)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Rename this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i163" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io" class="externalLink">Reader</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renderMarkdown(java.lang.String,org.kohsuke.github.MarkdownMode)">renderMarkdown</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> text,
|
|
<a href="MarkdownMode.html" title="enum in org.kohsuke.github">MarkdownMode</a> mode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Render a Markdown document.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i164" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDefaultBranch(java.lang.String)">setDefaultBranch</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> value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets default branch.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i165" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDescription(java.lang.String)">setDescription</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> value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets description.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i166" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEmailServiceHook(java.lang.String)">setEmailServiceHook</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> address)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets email service hook.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i167" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHomepage(java.lang.String)">setHomepage</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> value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets homepage.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i168" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPrivate(boolean)">setPrivate</a></span>​(boolean value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets private.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i169" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTopics(java.util.List)">setTopics</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="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>> topics)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the topics for this repository.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i170" class="altColor">
|
|
<td class="colFirst"><code><a href="GHSubscription.html" title="class in org.kohsuke.github">GHSubscription</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subscribe(boolean,boolean)">subscribe</a></span>​(boolean subscribed,
|
|
boolean ignored)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Subscribes to this repository to get notifications.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<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#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#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#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>
|
|
</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>GHRepository</h4>
|
|
<pre>public GHRepository()</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="createDeployment(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createDeployment</h4>
|
|
<pre class="methodSignature">public <a href="GHDeploymentBuilder.html" title="class in org.kohsuke.github">GHDeploymentBuilder</a> createDeployment​(<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> ref)</pre>
|
|
<div class="block">Create deployment gh deployment builder.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>ref</code> - the ref</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh deployment builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getDeploymentStatuses(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDeploymentStatuses</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHDeploymentStatus.html" title="class in org.kohsuke.github">GHDeploymentStatus</a>> getDeploymentStatuses​(int id)
|
|
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 <code>getDeployment(id).listStatuses()</code></div>
|
|
</div>
|
|
<div class="block">Gets deployment statuses.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - the id</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the deployment statuses</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="listDeployments(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listDeployments</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHDeployment.html" title="class in org.kohsuke.github">GHDeployment</a>> listDeployments​(<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> ref,
|
|
<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> task,
|
|
<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> environment)</pre>
|
|
<div class="block">List deployments paged iterable.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sha</code> - the sha</dd>
|
|
<dd><code>ref</code> - the ref</dd>
|
|
<dd><code>task</code> - the task</dd>
|
|
<dd><code>environment</code> - the environment</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getDeployment(long)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDeployment</h4>
|
|
<pre class="methodSignature">public <a href="GHDeployment.html" title="class in org.kohsuke.github">GHDeployment</a> getDeployment​(long id)
|
|
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 a single <a href="GHDeployment.html" title="class in org.kohsuke.github"><code>GHDeployment</code></a> by its ID.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - the id</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the deployment</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="createDeployStatus(int,org.kohsuke.github.GHDeploymentState)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createDeployStatus</h4>
|
|
<pre class="methodSignature">public <a href="GHDeploymentStatusBuilder.html" title="class in org.kohsuke.github">GHDeploymentStatusBuilder</a> createDeployStatus​(int deploymentId,
|
|
<a href="GHDeploymentState.html" title="enum in org.kohsuke.github">GHDeploymentState</a> ghDeploymentState)
|
|
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 <code>getDeployment(deploymentId).createStatus(ghDeploymentState)</code></div>
|
|
</div>
|
|
<div class="block">Gets deploy status.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>deploymentId</code> - the deployment id</dd>
|
|
<dd><code>ghDeploymentState</code> - the gh deployment state</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the deploy status</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="getDescription()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDescription</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> getDescription()</pre>
|
|
<div class="block">Gets description.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the description</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getHomepage()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHomepage</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> getHomepage()</pre>
|
|
<div class="block">Gets homepage.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the homepage</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getGitTransportUrl()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getGitTransportUrl</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> getGitTransportUrl()</pre>
|
|
<div class="block">Gets the git:// URL to this repository, such as "git://github.com/kohsuke/jenkins.git" This URL is read-only.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the git transport url</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getHttpTransportUrl()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHttpTransportUrl</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> getHttpTransportUrl()</pre>
|
|
<div class="block">Gets the HTTPS URL to this repository, such as "https://github.com/kohsuke/jenkins.git" This URL is read-only.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the http transport url</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="gitHttpTransportUrl()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>gitHttpTransportUrl</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> gitHttpTransportUrl()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Typo of <a href="#getHttpTransportUrl()"><code>getHttpTransportUrl()</code></a></div>
|
|
</div>
|
|
<div class="block">Git http transport url string.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the string</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getSvnUrl()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSvnUrl</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> getSvnUrl()</pre>
|
|
<div class="block">Gets the Subversion URL to access this repository: https://github.com/rails/rails</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the svn url</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMirrorUrl()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMirrorUrl</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> getMirrorUrl()</pre>
|
|
<div class="block">Gets the Mirror URL to access this repository: https://github.com/apache/tomee mirrored from
|
|
git://git.apache.org/tomee.git</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the mirror url</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getSshUrl()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSshUrl</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> getSshUrl()</pre>
|
|
<div class="block">Gets the SSH URL to access this repository, such as git@github.com:rails/rails.git</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the ssh url</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getHtmlUrl()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHtmlUrl</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> getHtmlUrl()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="GHObject.html#getHtmlUrl()">GHObject</a></code></span></div>
|
|
<div class="block">Gets html url.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="GHObject.html#getHtmlUrl()">getHtmlUrl</a></code> in class <code><a href="GHObject.html" title="class in org.kohsuke.github">GHObject</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>URL of this object for humans, which renders some HTML.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getName</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> getName()</pre>
|
|
<div class="block">Short repository name without the owner. For example 'jenkins' in case of http://github.com/jenkinsci/jenkins</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the name</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getFullName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFullName</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> getFullName()</pre>
|
|
<div class="block">Full repository name including the owner or organization. For example 'jenkinsci/jenkins' in case of
|
|
http://github.com/jenkinsci/jenkins</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the full name</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasPullAccess()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasPullAccess</h4>
|
|
<pre class="methodSignature">public boolean hasPullAccess()</pre>
|
|
<div class="block">Has pull access boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasPushAccess()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasPushAccess</h4>
|
|
<pre class="methodSignature">public boolean hasPushAccess()</pre>
|
|
<div class="block">Has push access boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasAdminAccess()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasAdminAccess</h4>
|
|
<pre class="methodSignature">public boolean hasAdminAccess()</pre>
|
|
<div class="block">Has admin access boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getLanguage()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLanguage</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> getLanguage()</pre>
|
|
<div class="block">Gets the primary programming language.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the language</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getOwner()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getOwner</h4>
|
|
<pre class="methodSignature">public <a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a> getOwner()
|
|
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 owner.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the owner</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="getIssue(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getIssue</h4>
|
|
<pre class="methodSignature">public <a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a> getIssue​(int id)
|
|
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 issue.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - the id</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the issue</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="createIssue(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createIssue</h4>
|
|
<pre class="methodSignature">public <a href="GHIssueBuilder.html" title="class in org.kohsuke.github">GHIssueBuilder</a> createIssue​(<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> title)</pre>
|
|
<div class="block">Create issue gh issue builder.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>title</code> - the title</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh issue builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getIssues(org.kohsuke.github.GHIssueState)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getIssues</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="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a>> getIssues​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state)
|
|
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 issues.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>state</code> - the state</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the issues</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="getIssues(org.kohsuke.github.GHIssueState,org.kohsuke.github.GHMilestone)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getIssues</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="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a>> getIssues​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state,
|
|
<a href="GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a> milestone)
|
|
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 issues.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>state</code> - the state</dd>
|
|
<dd><code>milestone</code> - the milestone</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the issues</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="listIssues(org.kohsuke.github.GHIssueState)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listIssues</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHIssue.html" title="class in org.kohsuke.github">GHIssue</a>> listIssues​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state)</pre>
|
|
<div class="block">Lists up all the issues in this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>state</code> - the state</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createRelease(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createRelease</h4>
|
|
<pre class="methodSignature">public <a href="GHReleaseBuilder.html" title="class in org.kohsuke.github">GHReleaseBuilder</a> createRelease​(<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> tag)</pre>
|
|
<div class="block">Create release gh release builder.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>tag</code> - the tag</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh release builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createRef(java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createRef</h4>
|
|
<pre class="methodSignature">public <a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a> createRef​(<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> name,
|
|
<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">Creates a named ref, such as tag, branch, etc.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and
|
|
have at least two slashes, it will be rejected.</dd>
|
|
<dd><code>sha</code> - The SHA1 value to set this reference to</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh ref</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="getReleases()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReleases</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="GHRelease.html" title="class in org.kohsuke.github">GHRelease</a>> getReleases()
|
|
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="#listReleases()"><code>listReleases()</code></a></div>
|
|
</div>
|
|
<div class="block">Gets releases.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the releases</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="getRelease(long)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRelease</h4>
|
|
<pre class="methodSignature">public <a href="GHRelease.html" title="class in org.kohsuke.github">GHRelease</a> getRelease​(long id)
|
|
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 release.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - the id</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the release</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="getReleaseByTagName(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReleaseByTagName</h4>
|
|
<pre class="methodSignature">public <a href="GHRelease.html" title="class in org.kohsuke.github">GHRelease</a> getReleaseByTagName​(<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> tag)
|
|
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 release by tag name.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>tag</code> - the tag</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the release by tag name</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="getLatestRelease()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLatestRelease</h4>
|
|
<pre class="methodSignature">public <a href="GHRelease.html" title="class in org.kohsuke.github">GHRelease</a> getLatestRelease()
|
|
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 latest release.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the latest release</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="listReleases()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listReleases</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRelease.html" title="class in org.kohsuke.github">GHRelease</a>> listReleases()
|
|
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">List releases paged iterable.</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="listTags()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listTags</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHTag.html" title="class in org.kohsuke.github">GHTag</a>> listTags()
|
|
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">List tags paged iterable.</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="listLanguages()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listLanguages</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<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>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a>> listLanguages()
|
|
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">List languages for the specified repository. The value on the right of a language is the number of bytes of code
|
|
written in that language. { "C": 78769, "Python": 7769 }</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the map</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="getOwnerName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getOwnerName</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> getOwnerName()</pre>
|
|
<div class="block">Gets owner name.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the owner name</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasIssues()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasIssues</h4>
|
|
<pre class="methodSignature">public boolean hasIssues()</pre>
|
|
<div class="block">Has issues boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasWiki()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasWiki</h4>
|
|
<pre class="methodSignature">public boolean hasWiki()</pre>
|
|
<div class="block">Has wiki boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isFork()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isFork</h4>
|
|
<pre class="methodSignature">public boolean isFork()</pre>
|
|
<div class="block">Is fork boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isArchived()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isArchived</h4>
|
|
<pre class="methodSignature">public boolean isArchived()</pre>
|
|
<div class="block">Is archived boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isAllowSquashMerge()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isAllowSquashMerge</h4>
|
|
<pre class="methodSignature">public boolean isAllowSquashMerge()</pre>
|
|
<div class="block">Is allow squash merge boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isAllowMergeCommit()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isAllowMergeCommit</h4>
|
|
<pre class="methodSignature">public boolean isAllowMergeCommit()</pre>
|
|
<div class="block">Is allow merge commit boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isAllowRebaseMerge()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isAllowRebaseMerge</h4>
|
|
<pre class="methodSignature">public boolean isAllowRebaseMerge()</pre>
|
|
<div class="block">Is allow rebase merge boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getForks()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getForks</h4>
|
|
<pre class="methodSignature">public int getForks()</pre>
|
|
<div class="block">Returns the number of all forks of this repository. This not only counts direct forks, but also forks of forks,
|
|
and so on.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the forks</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getStargazersCount()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getStargazersCount</h4>
|
|
<pre class="methodSignature">public int getStargazersCount()</pre>
|
|
<div class="block">Gets stargazers count.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the stargazers count</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isPrivate()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isPrivate</h4>
|
|
<pre class="methodSignature">public boolean isPrivate()</pre>
|
|
<div class="block">Is private boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasDownloads()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasDownloads</h4>
|
|
<pre class="methodSignature">public boolean hasDownloads()</pre>
|
|
<div class="block">Has downloads boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="hasPages()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasPages</h4>
|
|
<pre class="methodSignature">public boolean hasPages()</pre>
|
|
<div class="block">Has pages boolean.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the boolean</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getWatchers()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getWatchers</h4>
|
|
<pre class="methodSignature">public int getWatchers()</pre>
|
|
<div class="block">Gets watchers.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the watchers</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getOpenIssueCount()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getOpenIssueCount</h4>
|
|
<pre class="methodSignature">public int getOpenIssueCount()</pre>
|
|
<div class="block">Gets open issue count.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the open issue count</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getNetworkCount()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNetworkCount</h4>
|
|
<pre class="methodSignature">public int getNetworkCount()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">This no longer exists in the official API documentation. Use <a href="#getForks()"><code>getForks()</code></a></div>
|
|
</div>
|
|
<div class="block">Gets network count.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the network count</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getSubscribersCount()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSubscribersCount</h4>
|
|
<pre class="methodSignature">public int getSubscribersCount()</pre>
|
|
<div class="block">Gets subscribers count.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the subscribers count</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getPushedAt()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPushedAt</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> getPushedAt()</pre>
|
|
<div class="block">Gets pushed at.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>null if the repository was never pushed at.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getDefaultBranch()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDefaultBranch</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> getDefaultBranch()</pre>
|
|
<div class="block">Returns the primary branch you'll configure in the "Admin > Options" config page.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This field is null until the user explicitly configures the master branch.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMasterBranch()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMasterBranch</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> getMasterBranch()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Renamed to <a href="#getDefaultBranch()"><code>getDefaultBranch()</code></a></div>
|
|
</div>
|
|
<div class="block">Gets master branch.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the master branch</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getSize()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSize</h4>
|
|
<pre class="methodSignature">public int getSize()</pre>
|
|
<div class="block">Gets size.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the size</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getCollaborators()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCollaborators</h4>
|
|
<pre class="methodSignature">@WithBridgeMethods(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">java.util.Set.class</a>)
|
|
public <a href="GHPersonSet.html" title="class in org.kohsuke.github">GHPersonSet</a><<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> getCollaborators()
|
|
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 the collaborators on this repository. This set always appear to include the owner.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the collaborators</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="listCollaborators()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listCollaborators</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> listCollaborators()
|
|
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">Lists up the collaborators on this repository.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Users 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="listAssignees()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listAssignees</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> listAssignees()
|
|
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">Lists all
|
|
<a href="https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/">the
|
|
available assignees</a> to which issues may be assigned.</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="hasAssignee(org.kohsuke.github.GHUser)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasAssignee</h4>
|
|
<pre class="methodSignature">public boolean hasAssignee​(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a> u)
|
|
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">Checks if the given user is an assignee for this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>u</code> - the u</dd>
|
|
<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="getCollaboratorNames()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCollaboratorNames</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<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>> getCollaboratorNames()
|
|
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 the names of the collaborators on this repository. This method deviates from the principle of this library
|
|
but it works a lot faster than <a href="#getCollaborators()"><code>getCollaborators()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the collaborator names</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="getPermission(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPermission</h4>
|
|
<pre class="methodSignature">public <a href="GHPermissionType.html" title="enum in org.kohsuke.github">GHPermissionType</a> getPermission​(<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> user)
|
|
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">Obtain permission for a given user in this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>user</code> - a <a href="GHPerson.html#getLogin()"><code>GHPerson.getLogin()</code></a></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the permission</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="getPermission(org.kohsuke.github.GHUser)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPermission</h4>
|
|
<pre class="methodSignature">public <a href="GHPermissionType.html" title="enum in org.kohsuke.github">GHPermissionType</a> getPermission​(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a> u)
|
|
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">Obtain permission for a given user in this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>u</code> - the u</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the permission</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="getTeams()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTeams</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="GHTeam.html" title="class in org.kohsuke.github">GHTeam</a>> getTeams()
|
|
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">If this repository belongs to an organization, return a set of teams.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>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="addCollaborators(org.kohsuke.github.GHUser...)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addCollaborators</h4>
|
|
<pre class="methodSignature">public void addCollaborators​(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>... users)
|
|
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">Add collaborators.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>users</code> - the users</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="addCollaborators(java.util.Collection)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addCollaborators</h4>
|
|
<pre class="methodSignature">public void addCollaborators​(<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="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> users)
|
|
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">Add collaborators.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>users</code> - the users</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="removeCollaborators(org.kohsuke.github.GHUser...)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeCollaborators</h4>
|
|
<pre class="methodSignature">public void removeCollaborators​(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>... users)
|
|
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">Remove collaborators.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>users</code> - the users</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="removeCollaborators(java.util.Collection)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeCollaborators</h4>
|
|
<pre class="methodSignature">public void removeCollaborators​(<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="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> users)
|
|
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">Remove collaborators.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>users</code> - the users</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="setEmailServiceHook(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setEmailServiceHook</h4>
|
|
<pre class="methodSignature">public void setEmailServiceHook​(<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> address)
|
|
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">Sets email service hook.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>address</code> - the address</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="enableIssueTracker(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>enableIssueTracker</h4>
|
|
<pre class="methodSignature">public void enableIssueTracker​(boolean v)
|
|
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">Enables or disables the issue tracker for this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>v</code> - the v</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="enableWiki(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>enableWiki</h4>
|
|
<pre class="methodSignature">public void enableWiki​(boolean v)
|
|
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">Enables or disables Wiki for this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>v</code> - the v</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="enableDownloads(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>enableDownloads</h4>
|
|
<pre class="methodSignature">public void enableDownloads​(boolean v)
|
|
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">Enable downloads.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>v</code> - the v</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="renameTo(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>renameTo</h4>
|
|
<pre class="methodSignature">public void renameTo​(<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> name)
|
|
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">Rename this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name</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="setDescription(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setDescription</h4>
|
|
<pre class="methodSignature">public void setDescription​(<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> value)
|
|
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">Sets description.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the value</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="setHomepage(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setHomepage</h4>
|
|
<pre class="methodSignature">public void setHomepage​(<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> value)
|
|
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">Sets homepage.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the value</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="setDefaultBranch(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setDefaultBranch</h4>
|
|
<pre class="methodSignature">public void setDefaultBranch​(<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> value)
|
|
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">Sets default branch.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the value</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="setPrivate(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setPrivate</h4>
|
|
<pre class="methodSignature">public void setPrivate​(boolean value)
|
|
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">Sets private.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the value</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="allowSquashMerge(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>allowSquashMerge</h4>
|
|
<pre class="methodSignature">public void allowSquashMerge​(boolean value)
|
|
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">Allow squash merge.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the value</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="allowMergeCommit(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>allowMergeCommit</h4>
|
|
<pre class="methodSignature">public void allowMergeCommit​(boolean value)
|
|
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">Allow merge commit.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the value</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="allowRebaseMerge(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>allowRebaseMerge</h4>
|
|
<pre class="methodSignature">public void allowRebaseMerge​(boolean value)
|
|
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">Allow rebase merge.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the value</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="delete()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>delete</h4>
|
|
<pre class="methodSignature">public void delete()
|
|
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">Deletes this repository.</div>
|
|
<dl>
|
|
<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="archive()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>archive</h4>
|
|
<pre class="methodSignature">public void archive()
|
|
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">Will archive and this repository as read-only. When a repository is archived, any operation that can change its
|
|
state is forbidden. This applies symmetrically if trying to unarchive it.
|
|
|
|
<p>
|
|
When you try to do any operation that modifies a read-only repository, it returns the response:
|
|
|
|
<pre>
|
|
org.kohsuke.github.HttpException: {
|
|
"message":"Repository was archived so is read-only.",
|
|
"documentation_url":"https://developer.github.com/v3/repos/#edit"
|
|
}
|
|
</pre></div>
|
|
<dl>
|
|
<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> - In case of any networking error or error from the server.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listForks()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listForks</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>> listForks()</pre>
|
|
<div class="block">Lists all the direct forks of this repository, sorted by github api default, currently <a href="GHRepository.ForkSort.html#NEWEST"><code>ForkSort.NEWEST</code></a>*.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listForks(org.kohsuke.github.GHRepository.ForkSort)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listForks</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>> listForks​(<a href="GHRepository.ForkSort.html" title="enum in org.kohsuke.github">GHRepository.ForkSort</a> sort)</pre>
|
|
<div class="block">Lists all the direct forks of this repository, sorted by the given sort order.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sort</code> - the sort order. If null, defaults to github api default, currently <a href="GHRepository.ForkSort.html#NEWEST"><code>ForkSort.NEWEST</code></a>.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="fork()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fork</h4>
|
|
<pre class="methodSignature">public <a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a> fork()
|
|
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">Forks this repository as your repository.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Newly forked repository that belong to you.</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="forkTo(org.kohsuke.github.GHOrganization)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>forkTo</h4>
|
|
<pre class="methodSignature">public <a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a> forkTo​(<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a> org)
|
|
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">Forks this repository into an organization.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>org</code> - the org</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Newly forked repository that belong to you.</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="getPullRequest(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPullRequest</h4>
|
|
<pre class="methodSignature">public <a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a> getPullRequest​(int i)
|
|
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">Retrieves a specified pull request.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>i</code> - the</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the pull request</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="getPullRequests(org.kohsuke.github.GHIssueState)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPullRequests</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="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a>> getPullRequests​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state)
|
|
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">Retrieves all the pull requests of a particular state.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>state</code> - the state</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the pull requests</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>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#listPullRequests(org.kohsuke.github.GHIssueState)"><code>#listPullRequests(GHIssueState)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listPullRequests(org.kohsuke.github.GHIssueState)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listPullRequests</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a>> listPullRequests​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <a href="#queryPullRequests()"><code>queryPullRequests()</code></a></div>
|
|
</div>
|
|
<div class="block">Retrieves all the pull requests of a particular state.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>state</code> - the state</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="queryPullRequests()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>queryPullRequests</h4>
|
|
<pre class="methodSignature">public <a href="GHPullRequestQueryBuilder.html" title="class in org.kohsuke.github">GHPullRequestQueryBuilder</a> queryPullRequests()</pre>
|
|
<div class="block">Retrieves pull requests.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh pull request query builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createPullRequest(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createPullRequest</h4>
|
|
<pre class="methodSignature">public <a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a> createPullRequest​(<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> title,
|
|
<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> head,
|
|
<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> base,
|
|
<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)
|
|
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">Creates a new pull request.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>title</code> - Required. The title of the pull request.</dd>
|
|
<dd><code>head</code> - Required. The name of the branch where your changes are implemented. For cross-repository pull
|
|
requests in the same network, namespace head with a user like this: username:branch.</dd>
|
|
<dd><code>base</code> - Required. The name of the branch you want your changes pulled into. This should be an existing branch
|
|
on the current repository.</dd>
|
|
<dd><code>body</code> - The contents of the pull request. This is the markdown description of a pull request.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh pull request</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="createPullRequest(java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createPullRequest</h4>
|
|
<pre class="methodSignature">public <a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a> createPullRequest​(<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> title,
|
|
<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> head,
|
|
<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> base,
|
|
<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,
|
|
boolean maintainerCanModify)
|
|
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">Creates a new pull request. Maintainer's permissions aware.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>title</code> - Required. The title of the pull request.</dd>
|
|
<dd><code>head</code> - Required. The name of the branch where your changes are implemented. For cross-repository pull
|
|
requests in the same network, namespace head with a user like this: username:branch.</dd>
|
|
<dd><code>base</code> - Required. The name of the branch you want your changes pulled into. This should be an existing branch
|
|
on the current repository.</dd>
|
|
<dd><code>body</code> - The contents of the pull request. This is the markdown description of a pull request.</dd>
|
|
<dd><code>maintainerCanModify</code> - Indicates whether maintainers can modify the pull request.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh pull request</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="createPullRequest(java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean,boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createPullRequest</h4>
|
|
<pre class="methodSignature">public <a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a> createPullRequest​(<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> title,
|
|
<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> head,
|
|
<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> base,
|
|
<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,
|
|
boolean maintainerCanModify,
|
|
boolean draft)
|
|
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">Creates a new pull request. Maintainer's permissions and draft aware.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>title</code> - Required. The title of the pull request.</dd>
|
|
<dd><code>head</code> - Required. The name of the branch where your changes are implemented. For cross-repository pull
|
|
requests in the same network, namespace head with a user like this: username:branch.</dd>
|
|
<dd><code>base</code> - Required. The name of the branch you want your changes pulled into. This should be an existing branch
|
|
on the current repository.</dd>
|
|
<dd><code>body</code> - The contents of the pull request. This is the markdown description of a pull request.</dd>
|
|
<dd><code>maintainerCanModify</code> - Indicates whether maintainers can modify the pull request.</dd>
|
|
<dd><code>draft</code> - Indicates whether to create a draft pull request or not.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh pull request</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="getHooks()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHooks</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="GHHook.html" title="class in org.kohsuke.github">GHHook</a>> getHooks()
|
|
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">Retrieves the currently configured hooks.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the hooks</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="getHook(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHook</h4>
|
|
<pre class="methodSignature">public <a href="GHHook.html" title="class in org.kohsuke.github">GHHook</a> getHook​(int id)
|
|
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 hook.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - the id</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the hook</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="getCompare(java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCompare</h4>
|
|
<pre class="methodSignature">public <a href="GHCompare.html" title="class in org.kohsuke.github">GHCompare</a> getCompare​(<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> id1,
|
|
<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> id2)
|
|
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 a comparison between 2 points in the repository. This would be similar to calling
|
|
<code>git log id1...id2</code> against a local repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id1</code> - an identifier for the first point to compare from, this can be a sha1 ID (for a commit, tag etc) or a
|
|
direct tag name</dd>
|
|
<dd><code>id2</code> - an identifier for the second point to compare to. Can be the same as the first point.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the comparison output</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> - on failure communicating with GitHub</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getCompare(org.kohsuke.github.GHCommit,org.kohsuke.github.GHCommit)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCompare</h4>
|
|
<pre class="methodSignature">public <a href="GHCompare.html" title="class in org.kohsuke.github">GHCompare</a> getCompare​(<a href="GHCommit.html" title="class in org.kohsuke.github">GHCommit</a> id1,
|
|
<a href="GHCommit.html" title="class in org.kohsuke.github">GHCommit</a> id2)
|
|
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 compare.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id1</code> - the id 1</dd>
|
|
<dd><code>id2</code> - the id 2</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the compare</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="getCompare(org.kohsuke.github.GHBranch,org.kohsuke.github.GHBranch)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCompare</h4>
|
|
<pre class="methodSignature">public <a href="GHCompare.html" title="class in org.kohsuke.github">GHCompare</a> getCompare​(<a href="GHBranch.html" title="class in org.kohsuke.github">GHBranch</a> id1,
|
|
<a href="GHBranch.html" title="class in org.kohsuke.github">GHBranch</a> id2)
|
|
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 compare.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id1</code> - the id 1</dd>
|
|
<dd><code>id2</code> - the id 2</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the compare</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="getRefs()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRefs</h4>
|
|
<pre class="methodSignature">public <a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a>[] getRefs()
|
|
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">Retrieves all refs for the github repository.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an array of GHRef elements coresponding with the refs in the remote repository.</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> - on failure communicating with GitHub</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listRefs()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listRefs</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a>> listRefs()
|
|
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">Retrieves all refs for the github repository.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>paged iterable of all refs</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> - on failure communicating with GitHub, potentially due to an invalid ref type being requested</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getRefs(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRefs</h4>
|
|
<pre class="methodSignature">public <a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a>[] getRefs​(<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> refType)
|
|
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">Retrieves all refs of the given type for the current GitHub repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>refType</code> - the type of reg to search for e.g. <code>tags</code> or <code>commits</code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an array of all refs matching the request type</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> - on failure communicating with GitHub, potentially due to an invalid ref type being requested</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listRefs(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listRefs</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a>> listRefs​(<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> refType)
|
|
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">Retrieves all refs of the given type for the current GitHub repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>refType</code> - the type of reg to search for e.g. <code>tags</code> or <code>commits</code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>paged iterable of all refs of the specified type</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> - on failure communicating with GitHub, potentially due to an invalid ref type being requested</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getRef(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRef</h4>
|
|
<pre class="methodSignature">public <a href="GHRef.html" title="class in org.kohsuke.github">GHRef</a> getRef​(<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> refName)
|
|
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">Retrive a ref of the given type for the current GitHub repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>refName</code> - eg: heads/branch</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>refs matching the request type</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> - on failure communicating with GitHub, potentially due to an invalid ref type being requested</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getTagObject(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTagObject</h4>
|
|
<pre class="methodSignature">public <a href="GHTagObject.html" title="class in org.kohsuke.github">GHTagObject</a> getTagObject​(<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">Returns the <strong>annotated</strong> tag object. Only valid if the <a href="GHRef.html#getObject()"><code>GHRef.getObject()</code></a> has a
|
|
<a href="GHRef.GHObject.html#getType()"><code>GHRef.GHObject.getType()</code></a> of <code>tag</code>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sha</code> - the sha of the tag object</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the annotated tag object</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="getTree(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTree</h4>
|
|
<pre class="methodSignature">public <a href="GHTree.html" title="class in org.kohsuke.github">GHTree</a> getTree​(<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">Retrive a tree of the given type for the current GitHub repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sha</code> - sha number or branch name ex: "master"</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>refs matching the request type</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> - on failure communicating with GitHub, potentially due to an invalid tree type being requested</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createTree()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createTree</h4>
|
|
<pre class="methodSignature">public <a href="GHTreeBuilder.html" title="class in org.kohsuke.github">GHTreeBuilder</a> createTree()</pre>
|
|
<div class="block">Create tree gh tree builder.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh tree builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getTreeRecursive(java.lang.String,int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTreeRecursive</h4>
|
|
<pre class="methodSignature">public <a href="GHTree.html" title="class in org.kohsuke.github">GHTree</a> getTreeRecursive​(<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,
|
|
int recursive)
|
|
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">Retrieves the tree for the current GitHub repository, recursively as described in here:
|
|
https://developer.github.com/v3/git/trees/#get-a-tree-recursively</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sha</code> - sha number or branch name ex: "master"</dd>
|
|
<dd><code>recursive</code> - use 1</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the tree recursive</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> - on failure communicating with GitHub, potentially due to an invalid tree type being requested</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getBlob(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBlob</h4>
|
|
<pre class="methodSignature">public <a href="GHBlob.html" title="class in org.kohsuke.github">GHBlob</a> getBlob​(<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> blobSha)
|
|
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 the metadata & the content of a blob.
|
|
|
|
<p>
|
|
This method retrieves the whole content in memory, so beware when you are dealing with large BLOB.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>blobSha</code> - the blob sha</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the blob</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>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="https://developer.github.com/v3/git/blobs/#get-a-blob">Get a blob</a>,
|
|
<a href="#readBlob(java.lang.String)"><code>#readBlob(String)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createBlob()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createBlob</h4>
|
|
<pre class="methodSignature">public <a href="GHBlobBuilder.html" title="class in org.kohsuke.github">GHBlobBuilder</a> createBlob()</pre>
|
|
<div class="block">Create blob gh blob builder.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh blob builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="readBlob(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readBlob</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> readBlob​(<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> blobSha)
|
|
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">Reads the content of a blob as a stream for better efficiency.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>blobSha</code> - the blob sha</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the input stream</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>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="https://developer.github.com/v3/git/blobs/#get-a-blob">Get a blob</a>,
|
|
<a href="#getBlob(java.lang.String)"><code>#getBlob(String)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getCommit(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCommit</h4>
|
|
<pre class="methodSignature">public <a href="GHCommit.html" title="class in org.kohsuke.github">GHCommit</a> getCommit​(<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> sha1)
|
|
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 a commit object in this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sha1</code> - the sha 1</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the commit</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="createCommit()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createCommit</h4>
|
|
<pre class="methodSignature">public <a href="GHCommitBuilder.html" title="class in org.kohsuke.github">GHCommitBuilder</a> createCommit()</pre>
|
|
<div class="block">Create commit gh commit builder.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh commit builder</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="GHCommit.html" title="class in org.kohsuke.github">GHCommit</a>> listCommits()</pre>
|
|
<div class="block">Lists all the commits.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="queryCommits()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>queryCommits</h4>
|
|
<pre class="methodSignature">public <a href="GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a> queryCommits()</pre>
|
|
<div class="block">Search commits by specifying filters through a builder pattern.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh commit query builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listCommitComments()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listCommitComments</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHCommitComment.html" title="class in org.kohsuke.github">GHCommitComment</a>> listCommitComments()</pre>
|
|
<div class="block">Lists up all the commit comments in this repository.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getLicense()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLicense</h4>
|
|
<pre class="methodSignature">public <a href="GHLicense.html" title="class in org.kohsuke.github">GHLicense</a> getLicense()
|
|
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 the basic license details for the repository.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>null if there's no license.</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> - as usual but also if you don't use the preview connector</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getLicenseContent()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLicenseContent</h4>
|
|
<pre class="methodSignature">public <a href="GHContent.html" title="class in org.kohsuke.github">GHContent</a> getLicenseContent()
|
|
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">Retrieves the contents of the repository's license file - makes an additional API call
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>details regarding the license contents, or null if there's no license.</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> - as usual but also if you don't use the preview connector</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listCommitStatuses(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listCommitStatuses</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHCommitStatus.html" title="class in org.kohsuke.github">GHCommitStatus</a>> listCommitStatuses​(<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> sha1)
|
|
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">/** Lists all the commit statues attached to the given commit, newer ones first.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sha1</code> - the sha 1</dd>
|
|
<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="getLastCommitStatus(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLastCommitStatus</h4>
|
|
<pre class="methodSignature">public <a href="GHCommitStatus.html" title="class in org.kohsuke.github">GHCommitStatus</a> getLastCommitStatus​(<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> sha1)
|
|
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 the last status of this commit, which is what gets shown in the UI.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sha1</code> - the sha 1</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the last commit status</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="createCommitStatus(java.lang.String,org.kohsuke.github.GHCommitState,java.lang.String,java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createCommitStatus</h4>
|
|
<pre class="methodSignature">public <a href="GHCommitStatus.html" title="class in org.kohsuke.github">GHCommitStatus</a> createCommitStatus​(<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> sha1,
|
|
<a href="GHCommitState.html" title="enum in org.kohsuke.github">GHCommitState</a> state,
|
|
<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> targetUrl,
|
|
<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> description,
|
|
<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> context)
|
|
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">Creates a commit status</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sha1</code> - the sha 1</dd>
|
|
<dd><code>state</code> - the state</dd>
|
|
<dd><code>targetUrl</code> - Optional parameter that points to the URL that has more details.</dd>
|
|
<dd><code>description</code> - Optional short description.</dd>
|
|
<dd><code>context</code> - Optinal commit status context.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh commit status</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="createCommitStatus(java.lang.String,org.kohsuke.github.GHCommitState,java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createCommitStatus</h4>
|
|
<pre class="methodSignature">public <a href="GHCommitStatus.html" title="class in org.kohsuke.github">GHCommitStatus</a> createCommitStatus​(<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> sha1,
|
|
<a href="GHCommitState.html" title="enum in org.kohsuke.github">GHCommitState</a> state,
|
|
<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> targetUrl,
|
|
<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> description)
|
|
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 commit status gh commit status.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sha1</code> - the sha 1</dd>
|
|
<dd><code>state</code> - the state</dd>
|
|
<dd><code>targetUrl</code> - the target url</dd>
|
|
<dd><code>description</code> - the description</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh commit status</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>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#createCommitStatus(java.lang.String,org.kohsuke.github.GHCommitState,java.lang.String,java.lang.String,java.lang.String)"><code>#createCommitStatus(String,
|
|
GHCommitState,String,String,String)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listEvents()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listEvents</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHEventInfo.html" title="class in org.kohsuke.github">GHEventInfo</a>> listEvents()
|
|
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">Lists repository events.</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="listLabels()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listLabels</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHLabel.html" title="class in org.kohsuke.github">GHLabel</a>> listLabels()
|
|
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">Lists labels in this repository.
|
|
<p>
|
|
https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository</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="getLabel(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLabel</h4>
|
|
<pre class="methodSignature">public <a href="GHLabel.html" title="class in org.kohsuke.github">GHLabel</a> getLabel​(<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> name)
|
|
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 label.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the label</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="createLabel(java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createLabel</h4>
|
|
<pre class="methodSignature">public <a href="GHLabel.html" title="class in org.kohsuke.github">GHLabel</a> createLabel​(<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> name,
|
|
<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> color)
|
|
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 label gh label.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name</dd>
|
|
<dd><code>color</code> - the color</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh label</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="createLabel(java.lang.String,java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createLabel</h4>
|
|
<pre class="methodSignature"><a href="Preview.html" title="annotation in org.kohsuke.github">@Preview</a>
|
|
<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="GHLabel.html" title="class in org.kohsuke.github">GHLabel</a> createLabel​(<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> name,
|
|
<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> color,
|
|
<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> description)
|
|
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">Description is still in preview.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name</dd>
|
|
<dd><code>color</code> - the color</dd>
|
|
<dd><code>description</code> - the description</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>gh label</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="listInvitations()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listInvitations</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHInvitation.html" title="class in org.kohsuke.github">GHInvitation</a>> listInvitations()</pre>
|
|
<div class="block">Lists all the invitations.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listSubscribers()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listSubscribers</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> listSubscribers()</pre>
|
|
<div class="block">Lists all the subscribers (aka watchers.)
|
|
<p>
|
|
https://developer.github.com/v3/activity/watching/</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listStargazers()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listStargazers</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>> listStargazers()</pre>
|
|
<div class="block">Lists all the users who have starred this repo based on the old version of the API. For additional information,
|
|
like date when the repository was starred, see <a href="#listStargazers2()"><code>listStargazers2()</code></a></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listStargazers2()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listStargazers2</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHStargazer.html" title="class in org.kohsuke.github">GHStargazer</a>> listStargazers2()</pre>
|
|
<div class="block">Lists all the users who have starred this repo based on new version of the API, having extended information like
|
|
the time when the repository was starred. For compatibility with the old API see <a href="#listStargazers()"><code>listStargazers()</code></a></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createHook(java.lang.String,java.util.Map,java.util.Collection,boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createHook</h4>
|
|
<pre class="methodSignature">public <a href="GHHook.html" title="class in org.kohsuke.github">GHHook</a> createHook​(<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> name,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<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>,​<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>> config,
|
|
<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="GHEvent.html" title="enum in org.kohsuke.github">GHEvent</a>> events,
|
|
boolean active)
|
|
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 https://api.github.com/hooks for possible names and their configuration scheme. TODO: produce type-safe
|
|
binding</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - Type of the hook to be created. See https://api.github.com/hooks for possible names.</dd>
|
|
<dd><code>config</code> - The configuration hash.</dd>
|
|
<dd><code>events</code> - Can be null. Types of events to hook into.</dd>
|
|
<dd><code>active</code> - the active</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh hook</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="createWebHook(java.net.URL,java.util.Collection)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createWebHook</h4>
|
|
<pre class="methodSignature">public <a href="GHHook.html" title="class in org.kohsuke.github">GHHook</a> createWebHook​(<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> url,
|
|
<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="GHEvent.html" title="enum in org.kohsuke.github">GHEvent</a>> events)
|
|
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 web hook gh hook.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>url</code> - the url</dd>
|
|
<dd><code>events</code> - the events</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh hook</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="createWebHook(java.net.URL)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createWebHook</h4>
|
|
<pre class="methodSignature">public <a href="GHHook.html" title="class in org.kohsuke.github">GHHook</a> createWebHook​(<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> url)
|
|
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 web hook gh hook.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>url</code> - the url</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh hook</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="getPostCommitHooks()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPostCommitHooks</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<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>> getPostCommitHooks()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Use <a href="#getHooks()"><code>getHooks()</code></a> and <a href="#createHook(java.lang.String,java.util.Map,java.util.Collection,boolean)"><code>createHook(String, Map, Collection, boolean)</code></a></div>
|
|
</div>
|
|
<div class="block">Returns a set that represents the post-commit hook URLs. The returned set is live, and changes made to them are
|
|
reflected to GitHub.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the post commit hooks</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getBranches()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBranches</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<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>,​<a href="GHBranch.html" title="class in org.kohsuke.github">GHBranch</a>> getBranches()
|
|
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 branches by <a href="GHBranch.html#getName()">their names</a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the branches</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="getBranch(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBranch</h4>
|
|
<pre class="methodSignature">public <a href="GHBranch.html" title="class in org.kohsuke.github">GHBranch</a> getBranch​(<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> name)
|
|
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 branch.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the branch</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="getMilestones()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMilestones</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a>> getMilestones()
|
|
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="#listMilestones(org.kohsuke.github.GHIssueState)"><code>listMilestones(GHIssueState)</code></a></div>
|
|
</div>
|
|
<div class="block">Gets milestones.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the milestones</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="listMilestones(org.kohsuke.github.GHIssueState)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listMilestones</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a>> listMilestones​(<a href="GHIssueState.html" title="enum in org.kohsuke.github">GHIssueState</a> state)</pre>
|
|
<div class="block">Lists up all the milestones in this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>state</code> - the state</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the paged iterable</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMilestone(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMilestone</h4>
|
|
<pre class="methodSignature">public <a href="GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a> getMilestone​(int number)
|
|
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 milestone.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>number</code> - the number</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the milestone</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="getFileContent(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFileContent</h4>
|
|
<pre class="methodSignature">public <a href="GHContent.html" title="class in org.kohsuke.github">GHContent</a> getFileContent​(<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)
|
|
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 file content.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>path</code> - the path</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the file content</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="getFileContent(java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFileContent</h4>
|
|
<pre class="methodSignature">public <a href="GHContent.html" title="class in org.kohsuke.github">GHContent</a> getFileContent​(<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,
|
|
<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> ref)
|
|
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 file content.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>path</code> - the path</dd>
|
|
<dd><code>ref</code> - the ref</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the file content</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="getDirectoryContent(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDirectoryContent</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="GHContent.html" title="class in org.kohsuke.github">GHContent</a>> getDirectoryContent​(<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)
|
|
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 directory content.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>path</code> - the path</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the directory content</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="getDirectoryContent(java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDirectoryContent</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="GHContent.html" title="class in org.kohsuke.github">GHContent</a>> getDirectoryContent​(<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,
|
|
<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> ref)
|
|
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 directory content.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>path</code> - the path</dd>
|
|
<dd><code>ref</code> - the ref</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the directory content</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="getReadme()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReadme</h4>
|
|
<pre class="methodSignature">public <a href="GHContent.html" title="class in org.kohsuke.github">GHContent</a> getReadme()
|
|
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">https://developer.github.com/v3/repos/contents/#get-the-readme</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the readme</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="createContent()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createContent</h4>
|
|
<pre class="methodSignature">public <a href="GHContentBuilder.html" title="class in org.kohsuke.github">GHContentBuilder</a> createContent()</pre>
|
|
<div class="block">Creates a new content, or update an existing content.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh content builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createContent(java.lang.String,java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createContent</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="GHContentUpdateResponse.html" title="class in org.kohsuke.github">GHContentUpdateResponse</a> createContent​(<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> content,
|
|
<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> commitMessage,
|
|
<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)
|
|
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">Use <a href="#createContent()"><code>createContent()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>content</code> - the content</dd>
|
|
<dd><code>commitMessage</code> - the commit message</dd>
|
|
<dd><code>path</code> - the path</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh content update response</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="createContent(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createContent</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="GHContentUpdateResponse.html" title="class in org.kohsuke.github">GHContentUpdateResponse</a> createContent​(<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> content,
|
|
<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> commitMessage,
|
|
<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,
|
|
<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> branch)
|
|
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">Use <a href="#createContent()"><code>createContent()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>content</code> - the content</dd>
|
|
<dd><code>commitMessage</code> - the commit message</dd>
|
|
<dd><code>path</code> - the path</dd>
|
|
<dd><code>branch</code> - the branch</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh content update response</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="createContent(byte[],java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createContent</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="GHContentUpdateResponse.html" title="class in org.kohsuke.github">GHContentUpdateResponse</a> createContent​(byte[] contentBytes,
|
|
<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> commitMessage,
|
|
<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)
|
|
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">Use <a href="#createContent()"><code>createContent()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>contentBytes</code> - the content bytes</dd>
|
|
<dd><code>commitMessage</code> - the commit message</dd>
|
|
<dd><code>path</code> - the path</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh content update response</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="createContent(byte[],java.lang.String,java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createContent</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="GHContentUpdateResponse.html" title="class in org.kohsuke.github">GHContentUpdateResponse</a> createContent​(byte[] contentBytes,
|
|
<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> commitMessage,
|
|
<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,
|
|
<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> branch)
|
|
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">Use <a href="#createContent()"><code>createContent()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>contentBytes</code> - the content bytes</dd>
|
|
<dd><code>commitMessage</code> - the commit message</dd>
|
|
<dd><code>path</code> - the path</dd>
|
|
<dd><code>branch</code> - the branch</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh content update response</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="createMilestone(java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createMilestone</h4>
|
|
<pre class="methodSignature">public <a href="GHMilestone.html" title="class in org.kohsuke.github">GHMilestone</a> createMilestone​(<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> title,
|
|
<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> description)
|
|
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 milestone gh milestone.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>title</code> - the title</dd>
|
|
<dd><code>description</code> - the description</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh milestone</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="addDeployKey(java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addDeployKey</h4>
|
|
<pre class="methodSignature">public <a href="GHDeployKey.html" title="class in org.kohsuke.github">GHDeployKey</a> addDeployKey​(<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> title,
|
|
<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> key)
|
|
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">Add deploy key gh deploy key.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>title</code> - the title</dd>
|
|
<dd><code>key</code> - the key</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh deploy key</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="getDeployKeys()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDeployKeys</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="GHDeployKey.html" title="class in org.kohsuke.github">GHDeployKey</a>> getDeployKeys()
|
|
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 deploy keys.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the deploy keys</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="getSource()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSource</h4>
|
|
<pre class="methodSignature">public <a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a> getSource()
|
|
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">Forked repositories have a 'source' attribute that specifies the ultimate source of the forking chain.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="GHRepository.html" title="class in org.kohsuke.github"><code>GHRepository</code></a> that points to the root repository where this repository is forked (indirectly or
|
|
directly) from. Otherwise null.</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>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#getParent()"><code>#getParent()</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getParent()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getParent</h4>
|
|
<pre class="methodSignature">public <a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a> getParent()
|
|
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">Forked repositories have a 'parent' attribute that specifies the repository this repository is directly forked
|
|
from. If we keep traversing <a href="#getParent()"><code>getParent()</code></a> until it returns null, that is <a href="#getSource()"><code>getSource()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="GHRepository.html" title="class in org.kohsuke.github"><code>GHRepository</code></a> that points to the repository where this repository is forked directly from.
|
|
Otherwise null.</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>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#getSource()"><code>#getSource()</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="subscribe(boolean,boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>subscribe</h4>
|
|
<pre class="methodSignature">public <a href="GHSubscription.html" title="class in org.kohsuke.github">GHSubscription</a> subscribe​(boolean subscribed,
|
|
boolean ignored)
|
|
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">Subscribes to this repository to get notifications.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>subscribed</code> - the subscribed</dd>
|
|
<dd><code>ignored</code> - the ignored</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh subscription</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="getSubscription()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSubscription</h4>
|
|
<pre class="methodSignature">public <a href="GHSubscription.html" title="class in org.kohsuke.github">GHSubscription</a> getSubscription()
|
|
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">Returns the current subscription.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>null if no subscription exists.</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="listContributors()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listContributors</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHRepository.Contributor.html" title="class in org.kohsuke.github">GHRepository.Contributor</a>> listContributors()
|
|
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">List contributors paged iterable.</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="getStatistics()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getStatistics</h4>
|
|
<pre class="methodSignature">public <a href="GHRepositoryStatistics.html" title="class in org.kohsuke.github">GHRepositoryStatistics</a> getStatistics()</pre>
|
|
<div class="block">Returns the statistics for this repository.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the statistics</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createProject(java.lang.String,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createProject</h4>
|
|
<pre class="methodSignature">public <a href="GHProject.html" title="class in org.kohsuke.github">GHProject</a> createProject​(<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> name,
|
|
<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)
|
|
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 a project for this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name</dd>
|
|
<dd><code>body</code> - the body</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh project</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="listProjects(org.kohsuke.github.GHProject.ProjectStateFilter)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listProjects</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHProject.html" title="class in org.kohsuke.github">GHProject</a>> listProjects​(<a href="GHProject.ProjectStateFilter.html" title="enum in org.kohsuke.github">GHProject.ProjectStateFilter</a> status)
|
|
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">Returns the projects for this repository.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>status</code> - The status filter (all, open or closed).</dd>
|
|
<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="listProjects()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listProjects</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHProject.html" title="class in org.kohsuke.github">GHProject</a>> listProjects()
|
|
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">Returns open projects for this repository.</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="renderMarkdown(java.lang.String,org.kohsuke.github.MarkdownMode)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>renderMarkdown</h4>
|
|
<pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io" class="externalLink">Reader</a> renderMarkdown​(<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> text,
|
|
<a href="MarkdownMode.html" title="enum in org.kohsuke.github">MarkdownMode</a> mode)
|
|
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">Render a Markdown document.
|
|
<p>
|
|
In <a href="MarkdownMode.html#GFM">GFM mode</a>, issue numbers and user mentions are linked accordingly.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>text</code> - the text</dd>
|
|
<dd><code>mode</code> - the mode</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the reader</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>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="GitHub.html#renderMarkdown(java.lang.String)"><code>GitHub#renderMarkdown(String)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listNotifications()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listNotifications</h4>
|
|
<pre class="methodSignature">public <a href="GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a> listNotifications()</pre>
|
|
<div class="block">List all the notifications in a repository for the current user.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the gh notification stream</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getViewTraffic()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getViewTraffic</h4>
|
|
<pre class="methodSignature">public <a href="GHRepositoryViewTraffic.html" title="class in org.kohsuke.github">GHRepositoryViewTraffic</a> getViewTraffic()
|
|
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"><a href="https://developer.github.com/v3/repos/traffic/#views">https://developer.github.com/v3/repos/traffic/#views</a></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the view traffic</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="getCloneTraffic()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCloneTraffic</h4>
|
|
<pre class="methodSignature">public <a href="GHRepositoryCloneTraffic.html" title="class in org.kohsuke.github">GHRepositoryCloneTraffic</a> getCloneTraffic()
|
|
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"><a href="https://developer.github.com/v3/repos/traffic/#clones">https://developer.github.com/v3/repos/traffic/#clones</a></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the clone traffic</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="hashCode()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hashCode</h4>
|
|
<pre class="methodSignature">public int hashCode()</pre>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><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></code> in class <code><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></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="equals(java.lang.Object)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>equals</h4>
|
|
<pre class="methodSignature">public boolean equals​(<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> obj)</pre>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><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></code> in class <code><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></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="listIssueEvents()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listIssueEvents</h4>
|
|
<pre class="methodSignature">public <a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="GHIssueEvent.html" title="class in org.kohsuke.github">GHIssueEvent</a>> listIssueEvents()
|
|
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">Get all issue events for this repository. See
|
|
https://developer.github.com/v3/issues/events/#list-events-for-a-repository</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="getIssueEvent(long)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getIssueEvent</h4>
|
|
<pre class="methodSignature">public <a href="GHIssueEvent.html" title="class in org.kohsuke.github">GHIssueEvent</a> getIssueEvent​(long id)
|
|
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">Get a single issue event. See https://developer.github.com/v3/issues/events/#get-a-single-event</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - the id</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the issue event</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="listTopics()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>listTopics</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="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>> listTopics()
|
|
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">Return the topics for this repository. See
|
|
https://developer.github.com/v3/repos/#list-all-topics-for-a-repository</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the list</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="setTopics(java.util.List)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>setTopics</h4>
|
|
<pre class="methodSignature">public void setTopics​(<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="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>> topics)
|
|
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">Set the topics for this repository. See
|
|
https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>topics</code> - the topics</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/GHRepository.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 © 2019. All rights reserved.</small></p>
|
|
</footer>
|
|
</body>
|
|
</html>
|