jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-05-08 15:52:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
bf902ab5c8aade1e5cbefa6db4cf39f5f3692552
github-api/apidocs/org/kohsuke/github/GitHub.html
Liam Newman bf902ab5c8 Update to v1.109
2020-04-01 15:08:20 -07:00

2159 lines
134 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.5) on Wed Apr 01 14:43:53 PDT 2020 -->
<title>GitHub (GitHub API for Java 1.109 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-04-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GitHub (GitHub API for Java 1.109 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":41,"i5":9,"i6":41,"i7":41,"i8":9,"i9":9,"i10":9,"i11":9,"i12":41,"i13":10,"i14":10,"i15":10,"i16":42,"i17":10,"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":42,"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":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":9,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":42,"i64":10,"i65":10,"i66":10,"i67":10,"i68":42};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/GitHub.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.kohsuke.github</a></div>
<h2 title="Class GitHub" class="title">Class GitHub</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>org.kohsuke.github.GitHub</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">GitHub</span>
extends <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></pre>
<div class="block">Root of the GitHub API.
<h2>Thread safety</h2>
<p>
This library aims to be safe for use by multiple threads concurrently, although the library itself makes no attempt
to control/serialize potentially conflicting operations to GitHub, such as updating &amp; deleting a repository at
the same time.</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">
<!-- ========== 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="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="#checkApiUrlValidity()">checkApiUrlValidity</a></span>()</code></th>
<td class="colLast">
<div class="block">Tests the connection.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkAuth(java.lang.String,java.lang.String)">checkAuth</a></span>&#8203;(<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>&nbsp;clientId,
<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>&nbsp;accessToken)</code></th>
<td class="colLast">
<div class="block">Check auth gh authorization.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connect()">connect</a></span>()</code></th>
<td class="colLast">
<div class="block">Obtains the credential from "~/.github" or from the System Environment Properties.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connect(java.lang.String,java.lang.String)">connect</a></span>&#8203;(<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>&nbsp;login,
<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>&nbsp;oauthAccessToken)</code></th>
<td class="colLast">
<div class="block">Connect git hub.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connect(java.lang.String,java.lang.String,java.lang.String)">connect</a></span>&#8203;(<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>&nbsp;login,
<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>&nbsp;oauthAccessToken,
<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>&nbsp;password)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="#connectUsingOAuth(java.lang.String)"><code>connectUsingOAuth(String)</code></a>.</div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectAnonymously()">connectAnonymously</a></span>()</code></th>
<td class="colLast">
<div class="block">Connects to GitHub anonymously.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectToEnterprise(java.lang.String,java.lang.String)">connectToEnterprise</a></span>&#8203;(<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>&nbsp;apiUrl,
<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>&nbsp;oauthAccessToken)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="#connectToEnterpriseWithOAuth(java.lang.String,java.lang.String,java.lang.String)"><code>connectToEnterpriseWithOAuth(String, String, String)</code></a></div>
</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectToEnterprise(java.lang.String,java.lang.String,java.lang.String)">connectToEnterprise</a></span>&#8203;(<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>&nbsp;apiUrl,
<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>&nbsp;login,
<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>&nbsp;password)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use with caution.</div>
</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectToEnterpriseAnonymously(java.lang.String)">connectToEnterpriseAnonymously</a></span>&#8203;(<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>&nbsp;apiUrl)</code></th>
<td class="colLast">
<div class="block">Connects to GitHub Enterprise anonymously.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectToEnterpriseWithOAuth(java.lang.String,java.lang.String,java.lang.String)">connectToEnterpriseWithOAuth</a></span>&#8203;(<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>&nbsp;apiUrl,
<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>&nbsp;login,
<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>&nbsp;oauthAccessToken)</code></th>
<td class="colLast">
<div class="block">Version that connects to GitHub Enterprise.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectUsingOAuth(java.lang.String)">connectUsingOAuth</a></span>&#8203;(<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>&nbsp;oauthAccessToken)</code></th>
<td class="colLast">
<div class="block">Connect using o auth git hub.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectUsingOAuth(java.lang.String,java.lang.String)">connectUsingOAuth</a></span>&#8203;(<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>&nbsp;githubServer,
<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>&nbsp;oauthAccessToken)</code></th>
<td class="colLast">
<div class="block">Connect using o auth git hub.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectUsingPassword(java.lang.String,java.lang.String)">connectUsingPassword</a></span>&#8203;(<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>&nbsp;login,
<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>&nbsp;password)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="#connectUsingOAuth(java.lang.String)"><code>connectUsingOAuth(String)</code></a> instead.</div>
</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="GHGistBuilder.html" title="class in org.kohsuke.github">GHGistBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createGist()">createGist</a></span>()</code></th>
<td class="colLast">
<div class="block">Create gist gh gist builder.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createOrGetAuth(java.lang.String,java.lang.String,java.util.List,java.lang.String,java.lang.String)">createOrGetAuth</a></span>&#8203;(<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>&nbsp;clientId,
<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>&nbsp;clientSecret,
<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>&lt;<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>&gt;&nbsp;scopes,
<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>&nbsp;note,
<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>&nbsp;note_url)</code></th>
<td class="colLast">
<div class="block">Create or get auth gh authorization.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="GHCreateRepositoryBuilder.html" title="class in org.kohsuke.github">GHCreateRepositoryBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRepository(java.lang.String)">createRepository</a></span>&#8203;(<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>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Starts a builder that creates a new repository.</div>
</td>
</tr>
<tr id="i16" 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="#createRepository(java.lang.String,java.lang.String,java.lang.String,boolean)">createRepository</a></span>&#8203;(<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>&nbsp;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>&nbsp;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>&nbsp;homepage,
boolean&nbsp;isPublic)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="#createRepository(java.lang.String)"><code>createRepository(String)</code></a> that uses a builder pattern to let you control every aspect.</div>
</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createToken(java.util.Collection,java.lang.String,java.lang.String)">createToken</a></span>&#8203;(<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>&lt;<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>&gt;&nbsp;scope,
<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>&nbsp;note,
<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>&nbsp;noteUrl)</code></th>
<td class="colLast">
<div class="block">Creates a new authorization.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createToken(java.util.Collection,java.lang.String,java.lang.String,java.util.function.Supplier)">createToken</a></span>&#8203;(<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>&lt;<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>&gt;&nbsp;scope,
<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>&nbsp;note,
<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>&nbsp;noteUrl,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a>&lt;<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>&gt;&nbsp;OTP)</code></th>
<td class="colLast">
<div class="block">Creates a new authorization using an OTP.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteAuth(long)">deleteAuth</a></span>&#8203;(long&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Delete auth.</div>
</td>
</tr>
<tr id="i20" 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="#getApiUrl()">getApiUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets api url.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="GHApp.html" title="class in org.kohsuke.github">GHApp</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getApp()">getApp</a></span>()</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="HttpConnector.html" title="interface in org.kohsuke.github">HttpConnector</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnector()">getConnector</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets connector.</div>
</td>
</tr>
<tr id="i23" 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>&lt;<a href="GHEventInfo.html" title="class in org.kohsuke.github">GHEventInfo</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEvents()">getEvents</a></span>()</code></th>
<td class="colLast">
<div class="block">Public events visible to you.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="GHGist.html" title="class in org.kohsuke.github">GHGist</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGist(java.lang.String)">getGist</a></span>&#8203;(<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>&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Gets a single gist by ID.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<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(java.lang.String)">getLicense</a></span>&#8203;(<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>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Returns the full details for a license</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="GHMeta.html" title="class in org.kohsuke.github">GHMeta</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMeta()">getMeta</a></span>()</code></th>
<td class="colLast">
<div class="block">Provides a list of GitHub's IP addresses.</div>
</td>
</tr>
<tr id="i27" 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>&lt;<a href="GHInvitation.html" title="class in org.kohsuke.github">GHInvitation</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMyInvitations()">getMyInvitations</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets complete list of open invitations for current user.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHMarketplaceUserPurchase.html" title="class in org.kohsuke.github">GHMarketplaceUserPurchase</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMyMarketplacePurchases()">getMyMarketplacePurchases</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns only active subscriptions.</div>
</td>
</tr>
<tr id="i29" 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>&lt;<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>,&#8203;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMyOrganizations()">getMyOrganizations</a></span>()</code></th>
<td class="colLast">
<div class="block">This method returns shallowly populated organizations.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code><a href="GHMyself.html" title="class in org.kohsuke.github">GHMyself</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMyself()">getMyself</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the <a href="GHUser.html" title="class in org.kohsuke.github"><code>GHUser</code></a> that represents yourself.</div>
</td>
</tr>
<tr id="i31" 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>&lt;<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>,&#8203;<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>&lt;<a href="GHTeam.html" title="class in org.kohsuke.github">GHTeam</a>&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMyTeams()">getMyTeams</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets complete map of organizations/teams that current user belongs to.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrganization(java.lang.String)">getOrganization</a></span>&#8203;(<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>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Gets <a href="GHOrganization.html" title="class in org.kohsuke.github"><code>GHOrganization</code></a> specified by name.</div>
</td>
</tr>
<tr id="i33" 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="#getProject(long)">getProject</a></span>&#8203;(long&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Gets project.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="GHProjectCard.html" title="class in org.kohsuke.github">GHProjectCard</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProjectCard(long)">getProjectCard</a></span>&#8203;(long&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Gets project card.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="GHProjectColumn.html" title="class in org.kohsuke.github">GHProjectColumn</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProjectColumn(long)">getProjectColumn</a></span>&#8203;(long&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Gets project column.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code><a href="GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRateLimit()">getRateLimit</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the current rate limit.</div>
</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="#getRepository(java.lang.String)">getRepository</a></span>&#8203;(<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>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Gets the repository object from 'user/reponame' string that GitHub calls as "repository name"</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="#getRepositoryById(java.lang.String)">getRepositoryById</a></span>&#8203;(<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>&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Gets the repository object from its ID</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><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="#getTeam(int)">getTeam</a></span>&#8203;(int&nbsp;id)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="GHOrganization.html#getTeam(int)"><code>GHOrganization.getTeam(int)</code></a></div>
</div>
</td>
</tr>
<tr id="i40" class="altColor">
<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="#getUser(java.lang.String)">getUser</a></span>&#8203;(<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>&nbsp;login)</code></th>
<td class="colLast">
<div class="block">Obtains the object that represents the named user.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>protected <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="#getUser(org.kohsuke.github.GHUser)">getUser</a></span>&#8203;(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>&nbsp;orig)</code></th>
<td class="colLast">
<div class="block">Interns the given <a href="GHUser.html" title="class in org.kohsuke.github"><code>GHUser</code></a>.</div>
</td>
</tr>
<tr id="i42" 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>&lt;<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>,&#8203;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserPublicOrganizations(java.lang.String)">getUserPublicOrganizations</a></span>&#8203;(<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>&nbsp;login)</code></th>
<td class="colLast">
<div class="block">This method returns a shallowly populated organizations.</div>
</td>
</tr>
<tr id="i43" 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>&lt;<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>,&#8203;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserPublicOrganizations(org.kohsuke.github.GHUser)">getUserPublicOrganizations</a></span>&#8203;(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>&nbsp;user)</code></th>
<td class="colLast">
<div class="block">Alias for <a href="#getUserPublicOrganizations(java.lang.String)"><code>getUserPublicOrganizations(String)</code></a>.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAnonymous()">isAnonymous</a></span>()</code></th>
<td class="colLast">
<div class="block">Is this an anonymous connection</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCredentialValid()">isCredentialValid</a></span>()</code></th>
<td class="colLast">
<div class="block">Ensures that the credential is valid.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOffline()">isOffline</a></span>()</code></th>
<td class="colLast">
<div class="block">Is this an always offline "connection".</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code><a href="GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lastRateLimit()">lastRateLimit</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the most recently observed rate limit data or <code>null</code> if either there is no rate limit (for example
GitHub Enterprise) or if no requests have been made.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listAllPublicRepositories()">listAllPublicRepositories</a></span>()</code></th>
<td class="colLast">
<div class="block">This provides a dump of every public repository, in the order that they were created.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listAllPublicRepositories(java.lang.String)">listAllPublicRepositories</a></span>&#8203;(<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>&nbsp;since)</code></th>
<td class="colLast">
<div class="block">This provides a dump of every public repository, in the order that they were created.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHLicense.html" title="class in org.kohsuke.github">GHLicense</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listLicenses()">listLicenses</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a list of popular open source licenses</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHMarketplacePlan.html" title="class in org.kohsuke.github">GHMarketplacePlan</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listMarketplacePlans()">listMarketplacePlans</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a list all plans for your Marketplace listing</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listMyAuthorizations()">listMyAuthorizations</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a list of all authorizations.</div>
</td>
</tr>
<tr id="i53" 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.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listOrganizations()">listOrganizations</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets a list of all organizations.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listOrganizations(java.lang.String)">listOrganizations</a></span>&#8203;(<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>&nbsp;since)</code></th>
<td class="colLast">
<div class="block">Gets a list of all organizations starting after the organization identifier specified by 'since'.</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code><a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listUsers()">listUsers</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a list of all users.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code>static <a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#offline()">offline</a></span>()</code></th>
<td class="colLast">
<div class="block">An offline-only <a href="GitHub.html" title="class in org.kohsuke.github"><code>GitHub</code></a> useful for parsing event notification from an unknown source.</div>
</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code>&lt;T extends <a href="GHEventPayload.html" title="class in org.kohsuke.github">GHEventPayload</a>&gt;<br>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseEventPayload(java.io.Reader,java.lang.Class)">parseEventPayload</a></span>&#8203;(<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>&nbsp;r,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;T&gt;&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Parses the GitHub event object.</div>
</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code><a href="GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rateLimit()">rateLimit</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the current rate limit while trying not to actually make any remote requests unless absolutely necessary.</div>
</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refreshCache()">refreshCache</a></span>()</code></th>
<td class="colLast">
<div class="block">clears all cached data in order for external changes (modifications and del) to be reflected</div>
</td>
</tr>
<tr id="i61" 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)">renderMarkdown</a></span>&#8203;(<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>&nbsp;text)</code></th>
<td class="colLast">
<div class="block">Render a Markdown document in raw mode.</div>
</td>
</tr>
<tr id="i62" class="altColor">
<td class="colFirst"><code><a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetAuth(java.lang.String,java.lang.String)">resetAuth</a></span>&#8203;(<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>&nbsp;clientId,
<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>&nbsp;accessToken)</code></th>
<td class="colLast">
<div class="block">Reset auth gh authorization.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<td class="colFirst"><code><a href="GHCommitSearchBuilder.html" title="class in org.kohsuke.github">GHCommitSearchBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchCommits()">searchCommits</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i64" class="altColor">
<td class="colFirst"><code><a href="GHContentSearchBuilder.html" title="class in org.kohsuke.github">GHContentSearchBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchContent()">searchContent</a></span>()</code></th>
<td class="colLast">
<div class="block">Search content.</div>
</td>
</tr>
<tr id="i65" class="rowColor">
<td class="colFirst"><code><a href="GHIssueSearchBuilder.html" title="class in org.kohsuke.github">GHIssueSearchBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchIssues()">searchIssues</a></span>()</code></th>
<td class="colLast">
<div class="block">Search issues.</div>
</td>
</tr>
<tr id="i66" class="altColor">
<td class="colFirst"><code><a href="GHRepositorySearchBuilder.html" title="class in org.kohsuke.github">GHRepositorySearchBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchRepositories()">searchRepositories</a></span>()</code></th>
<td class="colLast">
<div class="block">Search repositories.</div>
</td>
</tr>
<tr id="i67" class="rowColor">
<td class="colFirst"><code><a href="GHUserSearchBuilder.html" title="class in org.kohsuke.github">GHUserSearchBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchUsers()">searchUsers</a></span>()</code></th>
<td class="colLast">
<div class="block">Search users.</div>
</td>
</tr>
<tr id="i68" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConnector(org.kohsuke.github.HttpConnector)">setConnector</a></span>&#8203;(<a href="HttpConnector.html" title="interface in org.kohsuke.github">HttpConnector</a>&nbsp;connector)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">HttpConnector should not be changed.</div>
</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</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">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="connect()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre class="methodSignature">public static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connect()
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 credential from "~/.github" or from the System Environment Properties.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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="connectToEnterprise(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectToEnterprise</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 static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connectToEnterprise&#8203;(<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>&nbsp;apiUrl,
<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>&nbsp;oauthAccessToken)
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="#connectToEnterpriseWithOAuth(java.lang.String,java.lang.String,java.lang.String)"><code>connectToEnterpriseWithOAuth(String, String, String)</code></a></div>
</div>
<div class="block">Version that connects to GitHub Enterprise.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>apiUrl</code> - The URL of GitHub (or GitHub Enterprise) API endpoint, such as "https://api.github.com" or
"http://ghe.acme.com/api/v3". Note that GitHub Enterprise has <code>/api/v3</code> in the URL. For
historical reasons, this parameter still accepts the bare domain name, but that's considered
deprecated.</dd>
<dd><code>oauthAccessToken</code> - the oauth access token</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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="connectToEnterpriseWithOAuth(java.lang.String,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectToEnterpriseWithOAuth</h4>
<pre class="methodSignature">public static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connectToEnterpriseWithOAuth&#8203;(<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>&nbsp;apiUrl,
<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>&nbsp;login,
<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>&nbsp;oauthAccessToken)
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">Version that connects to GitHub Enterprise.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>apiUrl</code> - The URL of GitHub (or GitHub Enterprise) API endpoint, such as "https://api.github.com" or
"http://ghe.acme.com/api/v3". Note that GitHub Enterprise has <code>/api/v3</code> in the URL. For
historical reasons, this parameter still accepts the bare domain name, but that's considered
deprecated.</dd>
<dd><code>login</code> - the login</dd>
<dd><code>oauthAccessToken</code> - the oauth access token</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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="connectToEnterprise(java.lang.String,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectToEnterprise</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 static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connectToEnterprise&#8203;(<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>&nbsp;apiUrl,
<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>&nbsp;login,
<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>&nbsp;password)
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 with caution. Login with password is not a preferred method.</div>
</div>
<div class="block">Version that connects to GitHub Enterprise.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>apiUrl</code> - the api url</dd>
<dd><code>login</code> - the login</dd>
<dd><code>password</code> - the password</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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="connect(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre class="methodSignature">public static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connect&#8203;(<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>&nbsp;login,
<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>&nbsp;oauthAccessToken)
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">Connect git hub.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>login</code> - the login</dd>
<dd><code>oauthAccessToken</code> - the oauth access token</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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="connect(java.lang.String,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</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 static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connect&#8203;(<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>&nbsp;login,
<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>&nbsp;oauthAccessToken,
<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>&nbsp;password)
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="#connectUsingOAuth(java.lang.String)"><code>connectUsingOAuth(String)</code></a>.</div>
</div>
<div class="block">Connect git hub.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>login</code> - the login</dd>
<dd><code>oauthAccessToken</code> - the oauth access token</dd>
<dd><code>password</code> - the password</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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="connectUsingPassword(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectUsingPassword</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 static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connectUsingPassword&#8203;(<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>&nbsp;login,
<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>&nbsp;password)
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="#connectUsingOAuth(java.lang.String)"><code>connectUsingOAuth(String)</code></a> instead.</div>
</div>
<div class="block">Connect using password git hub.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>login</code> - the login</dd>
<dd><code>password</code> - the password</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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/changes/2020-02-14-deprecating-password-auth/#changes-to-make">Deprecating
password authentication and OAuth authorizations API</a></dd>
</dl>
</li>
</ul>
<a id="connectUsingOAuth(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectUsingOAuth</h4>
<pre class="methodSignature">public static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connectUsingOAuth&#8203;(<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>&nbsp;oauthAccessToken)
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">Connect using o auth git hub.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>oauthAccessToken</code> - the oauth access token</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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="connectUsingOAuth(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectUsingOAuth</h4>
<pre class="methodSignature">public static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connectUsingOAuth&#8203;(<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>&nbsp;githubServer,
<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>&nbsp;oauthAccessToken)
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">Connect using o auth git hub.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>githubServer</code> - the github server</dd>
<dd><code>oauthAccessToken</code> - the oauth access token</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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="connectAnonymously()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectAnonymously</h4>
<pre class="methodSignature">public static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connectAnonymously()
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">Connects to GitHub anonymously.
<p>
All operations that require authentication will fail.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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="connectToEnterpriseAnonymously(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectToEnterpriseAnonymously</h4>
<pre class="methodSignature">public static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;connectToEnterpriseAnonymously&#8203;(<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>&nbsp;apiUrl)
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">Connects to GitHub Enterprise anonymously.
<p>
All operations that require authentication will fail.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>apiUrl</code> - the api url</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the git hub</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="offline()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offline</h4>
<pre class="methodSignature">public static&nbsp;<a href="GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;offline()</pre>
<div class="block">An offline-only <a href="GitHub.html" title="class in org.kohsuke.github"><code>GitHub</code></a> useful for parsing event notification from an unknown source.
<p>
All operations that require a connection will fail.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An offline-only <a href="GitHub.html" title="class in org.kohsuke.github"><code>GitHub</code></a>.</dd>
</dl>
</li>
</ul>
<a id="isAnonymous()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAnonymous</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isAnonymous()</pre>
<div class="block">Is this an anonymous connection</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if operations that require authentication will fail.</dd>
</dl>
</li>
</ul>
<a id="isOffline()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOffline</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isOffline()</pre>
<div class="block">Is this an always offline "connection".</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this is an always offline "connection".</dd>
</dl>
</li>
</ul>
<a id="getConnector()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnector</h4>
<pre class="methodSignature">public&nbsp;<a href="HttpConnector.html" title="interface in org.kohsuke.github">HttpConnector</a>&nbsp;getConnector()</pre>
<div class="block">Gets connector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the connector</dd>
</dl>
</li>
</ul>
<a id="setConnector(org.kohsuke.github.HttpConnector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnector</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&nbsp;void&nbsp;setConnector&#8203;(<a href="HttpConnector.html" title="interface in org.kohsuke.github">HttpConnector</a>&nbsp;connector)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">HttpConnector should not be changed. If you find yourself needing to do this, file an issue.</div>
</div>
<div class="block">Sets the custom connector used to make requests to GitHub.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connector</code> - the connector</dd>
</dl>
</li>
</ul>
<a id="getApiUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApiUrl</h4>
<pre class="methodSignature">public&nbsp;<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>&nbsp;getApiUrl()</pre>
<div class="block">Gets api url.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the api url</dd>
</dl>
</li>
</ul>
<a id="getRateLimit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRateLimit</h4>
<pre class="methodSignature">public&nbsp;<a href="GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a>&nbsp;getRateLimit()
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 current rate limit.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rate limit</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="lastRateLimit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lastRateLimit</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/CheckForNull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@CheckForNull</a>
public&nbsp;<a href="GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a>&nbsp;lastRateLimit()</pre>
<div class="block">Returns the most recently observed rate limit data or <code>null</code> if either there is no rate limit (for example
GitHub Enterprise) or if no requests have been made.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the most recently observed rate limit data or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="rateLimit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rateLimit</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</a>
public&nbsp;<a href="GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a>&nbsp;rateLimit()
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 current rate limit while trying not to actually make any remote requests unless absolutely necessary.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current rate limit data.</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> - if we couldn't get the current rate limit data.</dd>
</dl>
</li>
</ul>
<a id="getMyself()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMyself</h4>
<pre class="methodSignature">@WithBridgeMethods(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser.class</a>)
public&nbsp;<a href="GHMyself.html" title="class in org.kohsuke.github">GHMyself</a>&nbsp;getMyself()
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 <a href="GHUser.html" title="class in org.kohsuke.github"><code>GHUser</code></a> that represents yourself.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the myself</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="getUser(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</h4>
<pre class="methodSignature">public&nbsp;<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>&nbsp;getUser&#8203;(<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>&nbsp;login)
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 object that represents the named user.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>login</code> - the login</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user</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="refreshCache()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refreshCache</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;refreshCache()</pre>
<div class="block">clears all cached data in order for external changes (modifications and del) to be reflected</div>
</li>
</ul>
<a id="getUser(org.kohsuke.github.GHUser)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</h4>
<pre class="methodSignature">protected&nbsp;<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>&nbsp;getUser&#8203;(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>&nbsp;orig)</pre>
<div class="block">Interns the given <a href="GHUser.html" title="class in org.kohsuke.github"><code>GHUser</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>orig</code> - the orig</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user</dd>
</dl>
</li>
</ul>
<a id="getOrganization(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrganization</h4>
<pre class="methodSignature">public&nbsp;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&nbsp;getOrganization&#8203;(<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>&nbsp;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 <a href="GHOrganization.html" title="class in org.kohsuke.github"><code>GHOrganization</code></a> specified by name.</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 organization</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="listOrganizations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listOrganizations</h4>
<pre class="methodSignature">public&nbsp;<a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&gt;&nbsp;listOrganizations()</pre>
<div class="block">Gets a list of all organizations.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the paged iterable</dd>
</dl>
</li>
</ul>
<a id="listOrganizations(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listOrganizations</h4>
<pre class="methodSignature">public&nbsp;<a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&gt;&nbsp;listOrganizations&#8203;(<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>&nbsp;since)</pre>
<div class="block">Gets a list of all organizations starting after the organization identifier specified by 'since'.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>since</code> - the since</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the paged iterable</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.github.com/v3/orgs/#parameters">List All Orgs - Parameters</a></dd>
</dl>
</li>
</ul>
<a id="getRepository(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRepository</h4>
<pre class="methodSignature">public&nbsp;<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>&nbsp;getRepository&#8203;(<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>&nbsp;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 the repository object from 'user/reponame' string that GitHub calls as "repository name"</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 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> - the io exception</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="GHRepository.html#getName()"><code>GHRepository#getName()</code></a></dd>
</dl>
</li>
</ul>
<a id="getRepositoryById(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRepositoryById</h4>
<pre class="methodSignature">public&nbsp;<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>&nbsp;getRepositoryById&#8203;(<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>&nbsp;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 the repository object from 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 repository by id</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="listLicenses()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listLicenses</h4>
<pre class="methodSignature">public&nbsp;<a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHLicense.html" title="class in org.kohsuke.github">GHLicense</a>&gt;&nbsp;listLicenses()
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 a list of popular open source licenses</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of popular open source licenses</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/licenses/">GitHub API - Licenses</a></dd>
</dl>
</li>
</ul>
<a id="listUsers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listUsers</h4>
<pre class="methodSignature">public&nbsp;<a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>&gt;&nbsp;listUsers()
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 a list of all users.</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="getLicense(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLicense</h4>
<pre class="methodSignature">public&nbsp;<a href="GHLicense.html" title="class in org.kohsuke.github">GHLicense</a>&nbsp;getLicense&#8203;(<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>&nbsp;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">Returns the full details for a license</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The license key provided from the API</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The license details</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="GHLicense.html#getKey()"><code>GHLicense#getKey()</code></a></dd>
</dl>
</li>
</ul>
<a id="listMarketplacePlans()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMarketplacePlans</h4>
<pre class="methodSignature">public&nbsp;<a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHMarketplacePlan.html" title="class in org.kohsuke.github">GHMarketplacePlan</a>&gt;&nbsp;listMarketplacePlans()
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 a list all plans for your Marketplace listing
<p>
GitHub Apps must use a JWT to access this endpoint.
<p>
OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.</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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing">List
Plans</a></dd>
</dl>
</li>
</ul>
<a id="getMyInvitations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMyInvitations</h4>
<pre class="methodSignature">public&nbsp;<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>&lt;<a href="GHInvitation.html" title="class in org.kohsuke.github">GHInvitation</a>&gt;&nbsp;getMyInvitations()
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 complete list of open invitations for current user.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the my invitations</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="getMyOrganizations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMyOrganizations</h4>
<pre class="methodSignature">public&nbsp;<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>&lt;<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>,&#8203;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&gt;&nbsp;getMyOrganizations()
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">This method returns shallowly populated organizations.
<p>
To retrieve full organization details, you need to call <a href="#getOrganization(java.lang.String)"><code>getOrganization(String)</code></a> TODO: make this
automatic.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the my organizations</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="getMyMarketplacePurchases()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMyMarketplacePurchases</h4>
<pre class="methodSignature">public&nbsp;<a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHMarketplaceUserPurchase.html" title="class in org.kohsuke.github">GHMarketplaceUserPurchase</a>&gt;&nbsp;getMyMarketplacePurchases()
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 only active subscriptions.
<p>
You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to
access this endpoint
<p>
OAuth Apps must authenticate using an OAuth token.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the paged iterable of GHMarketplaceUserPurchase</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/apps/marketplace/#get-a-users-marketplace-purchases">Get a user's
Marketplace purchases</a></dd>
</dl>
</li>
</ul>
<a id="getUserPublicOrganizations(org.kohsuke.github.GHUser)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserPublicOrganizations</h4>
<pre class="methodSignature">public&nbsp;<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>&lt;<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>,&#8203;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&gt;&nbsp;getUserPublicOrganizations&#8203;(<a href="GHUser.html" title="class in org.kohsuke.github">GHUser</a>&nbsp;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">Alias for <a href="#getUserPublicOrganizations(java.lang.String)"><code>getUserPublicOrganizations(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user public organizations</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="getUserPublicOrganizations(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserPublicOrganizations</h4>
<pre class="methodSignature">public&nbsp;<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>&lt;<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>,&#8203;<a href="GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>&gt;&nbsp;getUserPublicOrganizations&#8203;(<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>&nbsp;login)
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">This method returns a shallowly populated organizations.
<p>
To retrieve full organization details, you need to call <a href="#getOrganization(java.lang.String)"><code>getOrganization(String)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>login</code> - the user to retrieve public Organization membership information for</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the public Organization memberships for the user</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="getMyTeams()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMyTeams</h4>
<pre class="methodSignature">public&nbsp;<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>&lt;<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>,&#8203;<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>&lt;<a href="GHTeam.html" title="class in org.kohsuke.github">GHTeam</a>&gt;&gt;&nbsp;getMyTeams()
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 complete map of organizations/teams that current user belongs to.
<p>
Leverages the new GitHub API /user/teams made available recently to get in a single call the complete set of
organizations, teams and permissions in a single call.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the my 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="getTeam(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTeam</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&nbsp;<a href="GHTeam.html" title="class in org.kohsuke.github">GHTeam</a>&nbsp;getTeam&#8203;(int&nbsp;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 <a href="GHOrganization.html#getTeam(int)"><code>GHOrganization.getTeam(int)</code></a></div>
</div>
<div class="block">Gets a sigle team by 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 team</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/teams/#get-team-legacy">deprecation notice</a></dd>
</dl>
</li>
</ul>
<a id="getEvents()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEvents</h4>
<pre class="methodSignature">public&nbsp;<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>&lt;<a href="GHEventInfo.html" title="class in org.kohsuke.github">GHEventInfo</a>&gt;&nbsp;getEvents()
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">Public events visible to you. Equivalent of what's displayed on https://github.com/</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the events</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="getGist(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGist</h4>
<pre class="methodSignature">public&nbsp;<a href="GHGist.html" title="class in org.kohsuke.github">GHGist</a>&nbsp;getGist&#8203;(<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>&nbsp;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 a single gist by 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 gist</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="createGist()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createGist</h4>
<pre class="methodSignature">public&nbsp;<a href="GHGistBuilder.html" title="class in org.kohsuke.github">GHGistBuilder</a>&nbsp;createGist()</pre>
<div class="block">Create gist gh gist builder.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh gist builder</dd>
</dl>
</li>
</ul>
<a id="parseEventPayload(java.io.Reader,java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseEventPayload</h4>
<pre class="methodSignature">public&nbsp;&lt;T extends <a href="GHEventPayload.html" title="class in org.kohsuke.github">GHEventPayload</a>&gt;&nbsp;T&nbsp;parseEventPayload&#8203;(<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>&nbsp;r,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;T&gt;&nbsp;type)
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">Parses the GitHub event object.
<p>
This is primarily intended for receiving a POST HTTP call from a hook. Unfortunately, hook script payloads aren't
self-descriptive, so you need to know the type of the payload you are expecting.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type parameter</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>r</code> - the r</dd>
<dd><code>type</code> - the type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the t</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="createRepository(java.lang.String,java.lang.String,java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createRepository</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&nbsp;<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>&nbsp;createRepository&#8203;(<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>&nbsp;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>&nbsp;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>&nbsp;homepage,
boolean&nbsp;isPublic)
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="#createRepository(java.lang.String)"><code>createRepository(String)</code></a> that uses a builder pattern to let you control every aspect.</div>
</div>
<div class="block">Creates a new repository.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name</dd>
<dd><code>description</code> - the description</dd>
<dd><code>homepage</code> - the homepage</dd>
<dd><code>isPublic</code> - the is public</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Newly created 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> - the io exception</dd>
</dl>
</li>
</ul>
<a id="createRepository(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createRepository</h4>
<pre class="methodSignature">public&nbsp;<a href="GHCreateRepositoryBuilder.html" title="class in org.kohsuke.github">GHCreateRepositoryBuilder</a>&nbsp;createRepository&#8203;(<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>&nbsp;name)</pre>
<div class="block">Starts a builder that creates a new repository.
<p>
You use the returned builder to set various properties, then call <a href="GHCreateRepositoryBuilder.html#create()"><code>GHCreateRepositoryBuilder.create()</code></a> to
finally create a repository.
<p>
To create a repository in an organization, see
<a href="GHOrganization.html#createRepository(java.lang.String,java.lang.String,java.lang.String,org.kohsuke.github.GHTeam,boolean)"><code>GHOrganization.createRepository(String, String, String, GHTeam, boolean)</code></a></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 gh create repository builder</dd>
</dl>
</li>
</ul>
<a id="createToken(java.util.Collection,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createToken</h4>
<pre class="methodSignature">public&nbsp;<a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a>&nbsp;createToken&#8203;(<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>&lt;<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>&gt;&nbsp;scope,
<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>&nbsp;note,
<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>&nbsp;noteUrl)
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 authorization.
<p>
The token created can be then used for <a href="#connectUsingOAuth(java.lang.String)"><code>connectUsingOAuth(String)</code></a> in the future.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scope</code> - the scope</dd>
<dd><code>note</code> - the note</dd>
<dd><code>noteUrl</code> - the note url</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh authorization</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="http://developer.github.com/v3/oauth/#create-a-new-authorization">Documentation</a></dd>
</dl>
</li>
</ul>
<a id="createToken(java.util.Collection,java.lang.String,java.lang.String,java.util.function.Supplier)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createToken</h4>
<pre class="methodSignature">public&nbsp;<a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a>&nbsp;createToken&#8203;(<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>&lt;<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>&gt;&nbsp;scope,
<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>&nbsp;note,
<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>&nbsp;noteUrl,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a>&lt;<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>&gt;&nbsp;OTP)
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 authorization using an OTP.
<p>
Start by running createToken, if exception is thrown, prompt for OTP from user
<p>
Once OTP is received, call this token request
<p>
The token created can be then used for <a href="#connectUsingOAuth(java.lang.String)"><code>connectUsingOAuth(String)</code></a> in the future.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scope</code> - the scope</dd>
<dd><code>note</code> - the note</dd>
<dd><code>noteUrl</code> - the note url</dd>
<dd><code>OTP</code> - the otp</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh authorization</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="http://developer.github.com/v3/oauth/#create-a-new-authorization">Documentation</a></dd>
</dl>
</li>
</ul>
<a id="createOrGetAuth(java.lang.String,java.lang.String,java.util.List,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createOrGetAuth</h4>
<pre class="methodSignature">public&nbsp;<a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a>&nbsp;createOrGetAuth&#8203;(<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>&nbsp;clientId,
<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>&nbsp;clientSecret,
<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>&lt;<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>&gt;&nbsp;scopes,
<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>&nbsp;note,
<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>&nbsp;note_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 or get auth gh authorization.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientId</code> - the client id</dd>
<dd><code>clientSecret</code> - the client secret</dd>
<dd><code>scopes</code> - the scopes</dd>
<dd><code>note</code> - the note</dd>
<dd><code>note_url</code> - the note url</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh authorization</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/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app">docs</a></dd>
</dl>
</li>
</ul>
<a id="deleteAuth(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAuth</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;deleteAuth&#8203;(long&nbsp;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">Delete auth.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the id</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/oauth_authorizations/#delete-an-authorization">Delete an
authorization</a></dd>
</dl>
</li>
</ul>
<a id="checkAuth(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkAuth</h4>
<pre class="methodSignature">public&nbsp;<a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a>&nbsp;checkAuth&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</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>&nbsp;clientId,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</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>&nbsp;accessToken)
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">Check auth gh authorization.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientId</code> - the client id</dd>
<dd><code>accessToken</code> - the access token</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh authorization</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/oauth_authorizations/#check-an-authorization">Check an
authorization</a></dd>
</dl>
</li>
</ul>
<a id="resetAuth(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetAuth</h4>
<pre class="methodSignature">public&nbsp;<a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a>&nbsp;resetAuth&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</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>&nbsp;clientId,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</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>&nbsp;accessToken)
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">Reset auth gh authorization.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientId</code> - the client id</dd>
<dd><code>accessToken</code> - the access token</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh authorization</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/oauth_authorizations/#reset-an-authorization">Reset an
authorization</a></dd>
</dl>
</li>
</ul>
<a id="listMyAuthorizations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMyAuthorizations</h4>
<pre class="methodSignature">public&nbsp;<a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a>&gt;&nbsp;listMyAuthorizations()
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 a list of all authorizations.</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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations">List your
authorizations</a></dd>
</dl>
</li>
</ul>
<a id="getApp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApp</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&nbsp;<a href="GHApp.html" title="class in org.kohsuke.github">GHApp</a>&nbsp;getApp()
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">Returns the GitHub App associated with the authentication credentials used.
<p>
You must use a JWT to access this endpoint.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the app</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/apps/#get-the-authenticated-github-app">Get the authenticated
GitHub App</a></dd>
</dl>
</li>
</ul>
<a id="isCredentialValid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCredentialValid</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isCredentialValid()</pre>
<div class="block">Ensures that the credential is valid.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the boolean</dd>
</dl>
</li>
</ul>
<a id="getMeta()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMeta</h4>
<pre class="methodSignature">public&nbsp;<a href="GHMeta.html" title="class in org.kohsuke.github">GHMeta</a>&nbsp;getMeta()
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">Provides a list of GitHub's IP addresses.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of <a href="GHMeta.html" title="class in org.kohsuke.github"><code>GHMeta</code></a></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> - if the credentials supplied are invalid or if you're trying to access it as a GitHub App via the JWT
authentication</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.github.com/v3/meta/#meta">Get Meta</a></dd>
</dl>
</li>
</ul>
<a id="getProject(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProject</h4>
<pre class="methodSignature">public&nbsp;<a href="GHProject.html" title="class in org.kohsuke.github">GHProject</a>&nbsp;getProject&#8203;(long&nbsp;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 project.</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 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="getProjectColumn(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProjectColumn</h4>
<pre class="methodSignature">public&nbsp;<a href="GHProjectColumn.html" title="class in org.kohsuke.github">GHProjectColumn</a>&nbsp;getProjectColumn&#8203;(long&nbsp;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 project column.</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 project column</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="getProjectCard(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProjectCard</h4>
<pre class="methodSignature">public&nbsp;<a href="GHProjectCard.html" title="class in org.kohsuke.github">GHProjectCard</a>&nbsp;getProjectCard&#8203;(long&nbsp;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 project card.</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 project card</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="checkApiUrlValidity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkApiUrlValidity</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;checkApiUrlValidity()
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">Tests the connection.
<p>
Verify that the API URL and credentials are valid to access this GitHub.
<p>
This method returns normally if the endpoint is reachable and verified to be GitHub API URL. Otherwise this
method throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>IOException</code></a> to indicate the problem.</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="searchCommits()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>searchCommits</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&nbsp;<a href="GHCommitSearchBuilder.html" title="class in org.kohsuke.github">GHCommitSearchBuilder</a>&nbsp;searchCommits()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Search commits.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh commit search builder</dd>
</dl>
</li>
</ul>
<a id="searchIssues()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>searchIssues</h4>
<pre class="methodSignature">public&nbsp;<a href="GHIssueSearchBuilder.html" title="class in org.kohsuke.github">GHIssueSearchBuilder</a>&nbsp;searchIssues()</pre>
<div class="block">Search issues.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh issue search builder</dd>
</dl>
</li>
</ul>
<a id="searchUsers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>searchUsers</h4>
<pre class="methodSignature">public&nbsp;<a href="GHUserSearchBuilder.html" title="class in org.kohsuke.github">GHUserSearchBuilder</a>&nbsp;searchUsers()</pre>
<div class="block">Search users.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh user search builder</dd>
</dl>
</li>
</ul>
<a id="searchRepositories()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>searchRepositories</h4>
<pre class="methodSignature">public&nbsp;<a href="GHRepositorySearchBuilder.html" title="class in org.kohsuke.github">GHRepositorySearchBuilder</a>&nbsp;searchRepositories()</pre>
<div class="block">Search repositories.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh repository search builder</dd>
</dl>
</li>
</ul>
<a id="searchContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>searchContent</h4>
<pre class="methodSignature">public&nbsp;<a href="GHContentSearchBuilder.html" title="class in org.kohsuke.github">GHContentSearchBuilder</a>&nbsp;searchContent()</pre>
<div class="block">Search content.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh content search builder</dd>
</dl>
</li>
</ul>
<a id="listNotifications()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listNotifications</h4>
<pre class="methodSignature">public&nbsp;<a href="GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a>&nbsp;listNotifications()</pre>
<div class="block">List all the notifications.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the gh notification stream</dd>
</dl>
</li>
</ul>
<a id="listAllPublicRepositories()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listAllPublicRepositories</h4>
<pre class="methodSignature">public&nbsp;<a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>&gt;&nbsp;listAllPublicRepositories()</pre>
<div class="block">This provides a dump of every public repository, in the order that they were created.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the paged iterable</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.github.com/v3/repos/#list-all-public-repositories">documentation</a></dd>
</dl>
</li>
</ul>
<a id="listAllPublicRepositories(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listAllPublicRepositories</h4>
<pre class="methodSignature">public&nbsp;<a href="PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>&gt;&nbsp;listAllPublicRepositories&#8203;(<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>&nbsp;since)</pre>
<div class="block">This provides a dump of every public repository, in the order that they were created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>since</code> - The numeric ID of the last Repository that you’ve seen. See <a href="GHObject.html#getId()"><code>GHObject.getId()</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the paged iterable</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.github.com/v3/repos/#list-all-public-repositories">documentation</a></dd>
</dl>
</li>
</ul>
<a id="renderMarkdown(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>renderMarkdown</h4>
<pre class="methodSignature">public&nbsp;<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>&nbsp;renderMarkdown&#8203;(<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>&nbsp;text)
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 in raw mode.
<p>
It takes a Markdown document as plaintext and renders it as plain Markdown without a repository context (just
like a README.md file is rendered – this is the simplest way to preview a readme online).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text</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="GHRepository.html#renderMarkdown(java.lang.String,org.kohsuke.github.MarkdownMode)"><code>GHRepository#renderMarkdown(String, MarkdownMode)</code></a></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/GitHub.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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2020. All rights reserved.</small></p>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink