mirror of
https://github.com/jlengrand/github-api.git
synced 2026-05-08 15:52:17 +00:00
1437 lines
95 KiB
HTML
1437 lines
95 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
<!-- NewPage -->
|
||
<html lang="en">
|
||
<head>
|
||
<!-- Generated by javadoc (1.8.0_144) on Sat Jan 13 11:57:15 PST 2018 -->
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>GitHub (GitHub API for Java 1.92 API)</title>
|
||
<meta name="date" content="2018-01-13">
|
||
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
||
<script type="text/javascript" src="../../../script.js"></script>
|
||
</head>
|
||
<body>
|
||
<script type="text/javascript"><!--
|
||
try {
|
||
if (location.href.indexOf('is-external=true') == -1) {
|
||
parent.document.title="GitHub (GitHub API for Java 1.92 API)";
|
||
}
|
||
}
|
||
catch(err) {
|
||
}
|
||
//-->
|
||
var methods = {"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":9,"i13":10,"i14":10,"i15":10,"i16":42,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":42,"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":42,"i39":10,"i40":10,"i41":10,"i42":10,"i43":9,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":42,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10};
|
||
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";
|
||
</script>
|
||
<noscript>
|
||
<div>JavaScript is disabled on your browser.</div>
|
||
</noscript>
|
||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
<div class="topNav"><a name="navbar.top">
|
||
<!-- -->
|
||
</a>
|
||
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
||
<a name="navbar.top.firstrow">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="navList" title="Navigation">
|
||
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
<li><a href="package-summary.html">Package</a></li>
|
||
<li class="navBarCell1Rev">Class</li>
|
||
<li><a href="class-use/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">
|
||
<li><a href="../../../org/kohsuke/github/GHVerifiedKey.html" title="class in org.kohsuke.github"><span class="typeNameLink">Prev Class</span></a></li>
|
||
<li><a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github"><span class="typeNameLink">Next Class</span></a></li>
|
||
</ul>
|
||
<ul class="navList">
|
||
<li><a href="../../../index.html?org/kohsuke/github/GitHub.html" target="_top">Frames</a></li>
|
||
<li><a href="GitHub.html" target="_top">No Frames</a></li>
|
||
</ul>
|
||
<ul class="navList" id="allclasses_navbar_top">
|
||
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
||
</ul>
|
||
<div>
|
||
<script type="text/javascript"><!--
|
||
allClassesLink = document.getElementById("allclasses_navbar_top");
|
||
if(window==top) {
|
||
allClassesLink.style.display = "block";
|
||
}
|
||
else {
|
||
allClassesLink.style.display = "none";
|
||
}
|
||
//-->
|
||
</script>
|
||
</div>
|
||
<div>
|
||
<ul class="subNavList">
|
||
<li>Summary: </li>
|
||
<li>Nested | </li>
|
||
<li>Field | </li>
|
||
<li>Constr | </li>
|
||
<li><a href="#method.summary">Method</a></li>
|
||
</ul>
|
||
<ul class="subNavList">
|
||
<li>Detail: </li>
|
||
<li>Field | </li>
|
||
<li>Constr | </li>
|
||
<li><a href="#method.detail">Method</a></li>
|
||
</ul>
|
||
</div>
|
||
<a name="skip.navbar.top">
|
||
<!-- -->
|
||
</a></div>
|
||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
<!-- ======== START OF CLASS DATA ======== -->
|
||
<div class="header">
|
||
<div class="subTitle">org.kohsuke.github</div>
|
||
<h2 title="Class GitHub" class="title">Class GitHub</h2>
|
||
</div>
|
||
<div class="contentContainer">
|
||
<ul class="inheritance">
|
||
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">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>
|
||
<br>
|
||
<pre>public class <span class="typeNameLabel">GitHub</span>
|
||
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">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 & 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 =========== -->
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="method.summary">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Method Summary</h3>
|
||
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
|
||
<tr>
|
||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
<th class="colLast" scope="col">Method and Description</th>
|
||
</tr>
|
||
<tr id="i0" class="altColor">
|
||
<td class="colFirst"><code>void</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#checkApiUrlValidity--">checkApiUrlValidity</a></span>()</code>
|
||
<div class="block">Tests the connection.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i1" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#checkAuth-java.lang.String-java.lang.String-">checkAuth</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> accessToken)</code> </td>
|
||
</tr>
|
||
<tr id="i2" class="altColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connect--">connect</a></span>()</code>
|
||
<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="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connect-java.lang.String-java.lang.String-">connect</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken)</code> </td>
|
||
</tr>
|
||
<tr id="i4" class="altColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connect-java.lang.String-java.lang.String-java.lang.String-">connect</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
||
<div class="block"><span class="deprecationComment">Either OAuth token or password is sufficient, so there's no point in passing both.
|
||
Use <a href="../../../org/kohsuke/github/GitHub.html#connectUsingPassword-java.lang.String-java.lang.String-"><code>connectUsingPassword(String, String)</code></a> or <a href="../../../org/kohsuke/github/GitHub.html#connectUsingOAuth-java.lang.String-"><code>connectUsingOAuth(String)</code></a>.</span></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i5" class="rowColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connectAnonymously--">connectAnonymously</a></span>()</code>
|
||
<div class="block">Connects to GitHub anonymously.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i6" class="altColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connectToEnterprise-java.lang.String-java.lang.String-">connectToEnterprise</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> apiUrl,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken)</code>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
||
<div class="block"><span class="deprecationComment">Use <a href="../../../org/kohsuke/github/GitHub.html#connectToEnterpriseWithOAuth-java.lang.String-java.lang.String-java.lang.String-"><code>connectToEnterpriseWithOAuth(String, String, String)</code></a></span></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i7" class="rowColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connectToEnterprise-java.lang.String-java.lang.String-java.lang.String-">connectToEnterprise</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> apiUrl,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
||
<div class="block"><span class="deprecationComment">Use with caution. Login with password is not a preferred method.</span></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i8" class="altColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connectToEnterpriseAnonymously-java.lang.String-">connectToEnterpriseAnonymously</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> apiUrl)</code>
|
||
<div class="block">Connects to GitHub Enterprise anonymously.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i9" class="rowColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connectToEnterpriseWithOAuth-java.lang.String-java.lang.String-java.lang.String-">connectToEnterpriseWithOAuth</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> apiUrl,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken)</code>
|
||
<div class="block">Version that connects to GitHub Enterprise.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i10" class="altColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connectUsingOAuth-java.lang.String-">connectUsingOAuth</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken)</code> </td>
|
||
</tr>
|
||
<tr id="i11" class="rowColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connectUsingOAuth-java.lang.String-java.lang.String-">connectUsingOAuth</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> githubServer,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken)</code> </td>
|
||
</tr>
|
||
<tr id="i12" class="altColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#connectUsingPassword-java.lang.String-java.lang.String-">connectUsingPassword</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code> </td>
|
||
</tr>
|
||
<tr id="i13" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHGistBuilder.html" title="class in org.kohsuke.github">GHGistBuilder</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#createGist--">createGist</a></span>()</code> </td>
|
||
</tr>
|
||
<tr id="i14" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#createOrGetAuth-java.lang.String-java.lang.String-java.util.List-java.lang.String-java.lang.String-">createOrGetAuth</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientSecret,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> scopes,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> note,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> note_url)</code> </td>
|
||
</tr>
|
||
<tr id="i15" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCreateRepositoryBuilder.html" title="class in org.kohsuke.github">GHCreateRepositoryBuilder</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#createRepository-java.lang.String-">createRepository</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
|
||
<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="../../../org/kohsuke/github/GHRepository.html" title="class in org.kohsuke.github">GHRepository</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#createRepository-java.lang.String-java.lang.String-java.lang.String-boolean-">createRepository</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> homepage,
|
||
boolean isPublic)</code>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
||
<div class="block"><span class="deprecationComment">Use <a href="../../../org/kohsuke/github/GitHub.html#createRepository-java.lang.String-"><code>createRepository(String)</code></a> that uses a builder pattern to let you control every aspect.</span></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i17" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#createToken-java.util.Collection-java.lang.String-java.lang.String-">createToken</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> scope,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> note,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> noteUrl)</code>
|
||
<div class="block">Creates a new authorization.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i18" class="altColor">
|
||
<td class="colFirst"><code>void</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#deleteAuth-long-">deleteAuth</a></span>(long id)</code> </td>
|
||
</tr>
|
||
<tr id="i19" class="rowColor">
|
||
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getApiUrl--">getApiUrl</a></span>()</code> </td>
|
||
</tr>
|
||
<tr id="i20" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/HttpConnector.html" title="interface in org.kohsuke.github">HttpConnector</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getConnector--">getConnector</a></span>()</code> </td>
|
||
</tr>
|
||
<tr id="i21" class="rowColor">
|
||
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/kohsuke/github/GHEventInfo.html" title="class in org.kohsuke.github">GHEventInfo</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getEvents--">getEvents</a></span>()</code>
|
||
<div class="block">Public events visible to you.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i22" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHGist.html" title="class in org.kohsuke.github">GHGist</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getGist-java.lang.String-">getGist</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</code>
|
||
<div class="block">Gets a sigle gist by ID.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i23" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHLicense.html" title="class in org.kohsuke.github">GHLicense</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getLicense-java.lang.String-">getLicense</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i24" class="altColor">
|
||
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getMyOrganizations--">getMyOrganizations</a></span>()</code>
|
||
<div class="block">/**
|
||
This method returns a shallowly populated organizations.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i25" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHMyself.html" title="class in org.kohsuke.github">GHMyself</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getMyself--">getMyself</a></span>()</code>
|
||
<div class="block">Gets the <a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github"><code>GHUser</code></a> that represents yourself.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i26" class="altColor">
|
||
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../org/kohsuke/github/GHTeam.html" title="class in org.kohsuke.github">GHTeam</a>>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getMyTeams--">getMyTeams</a></span>()</code>
|
||
<div class="block">Gets complete map of organizations/teams that current user belongs to.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i27" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getOrganization-java.lang.String-">getOrganization</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
|
||
<div class="block">Gets <a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github"><code>GHOrganization</code></a> specified by name.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i28" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getRateLimit--">getRateLimit</a></span>()</code>
|
||
<div class="block">Gets the current rate limit.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i29" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHRepository.html" title="class in org.kohsuke.github">GHRepository</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getRepository-java.lang.String-">getRepository</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
|
||
<div class="block">Gets the repository object from 'user/reponame' string that GitHub calls as "repository name"</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i30" class="altColor">
|
||
<td class="colFirst"><code>protected <a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getUser-org.kohsuke.github.GHUser-">getUser</a></span>(<a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a> orig)</code>
|
||
<div class="block">Interns the given <a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github"><code>GHUser</code></a>.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i31" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#getUser-java.lang.String-">getUser</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login)</code>
|
||
<div class="block">Obtains the object that represents the named user.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i32" class="altColor">
|
||
<td class="colFirst"><code>boolean</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#isAnonymous--">isAnonymous</a></span>()</code>
|
||
<div class="block">Is this an anonymous connection</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i33" class="rowColor">
|
||
<td class="colFirst"><code>boolean</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#isCredentialValid--">isCredentialValid</a></span>()</code>
|
||
<div class="block">Ensures that the credential is valid.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i34" class="altColor">
|
||
<td class="colFirst"><code>boolean</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#isOffline--">isOffline</a></span>()</code>
|
||
<div class="block">Is this an always offline "connection".</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i35" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#lastRateLimit--">lastRateLimit</a></span>()</code>
|
||
<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="i36" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#listAllPublicRepositories--">listAllPublicRepositories</a></span>()</code>
|
||
<div class="block">This provides a dump of every public repository, in the order that they were created.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i37" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#listAllPublicRepositories-java.lang.String-">listAllPublicRepositories</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> since)</code>
|
||
<div class="block">This provides a dump of every public repository, in the order that they were created.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i38" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHLicense.html" title="class in org.kohsuke.github">GHLicense</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#listLicenses--">listLicenses</a></span>()</code>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i39" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#listNotifications--">listNotifications</a></span>()</code>
|
||
<div class="block">List all the notifications.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i40" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#listOrganizations--">listOrganizations</a></span>()</code>
|
||
<div class="block">Gets a list of all organizations.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i41" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#listOrganizations-java.lang.String-">listOrganizations</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> since)</code>
|
||
<div class="block">Gets a list of all organizations starting after the organization identifier specified by 'since'.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i42" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#listUsers--">listUsers</a></span>()</code>
|
||
<div class="block">Returns a list of all users.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i43" class="rowColor">
|
||
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#offline--">offline</a></span>()</code>
|
||
<div class="block">An offline-only <a href="../../../org/kohsuke/github/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="i44" class="altColor">
|
||
<td class="colFirst"><code><T extends <a href="../../../org/kohsuke/github/GHEventPayload.html" title="class in org.kohsuke.github">GHEventPayload</a>><br>T</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#parseEventPayload-java.io.Reader-java.lang.Class-">parseEventPayload</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> r,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</code>
|
||
<div class="block">Parses the GitHub event object.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i45" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#rateLimit--">rateLimit</a></span>()</code>
|
||
<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="i46" class="altColor">
|
||
<td class="colFirst"><code>void</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#refreshCache--">refreshCache</a></span>()</code>
|
||
<div class="block">clears all cached data in order for external changes (modifications and del</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i47" class="rowColor">
|
||
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#renderMarkdown-java.lang.String-">renderMarkdown</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text)</code>
|
||
<div class="block">Render a Markdown document in raw mode.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i48" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#resetAuth-java.lang.String-java.lang.String-">resetAuth</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> accessToken)</code> </td>
|
||
</tr>
|
||
<tr id="i49" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitSearchBuilder.html" title="class in org.kohsuke.github">GHCommitSearchBuilder</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#searchCommits--">searchCommits</a></span>()</code>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i50" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHContentSearchBuilder.html" title="class in org.kohsuke.github">GHContentSearchBuilder</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#searchContent--">searchContent</a></span>()</code>
|
||
<div class="block">Search content.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i51" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHIssueSearchBuilder.html" title="class in org.kohsuke.github">GHIssueSearchBuilder</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#searchIssues--">searchIssues</a></span>()</code>
|
||
<div class="block">Search issues.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i52" class="altColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHRepositorySearchBuilder.html" title="class in org.kohsuke.github">GHRepositorySearchBuilder</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#searchRepositories--">searchRepositories</a></span>()</code>
|
||
<div class="block">Search repositories.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i53" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHUserSearchBuilder.html" title="class in org.kohsuke.github">GHUserSearchBuilder</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#searchUsers--">searchUsers</a></span>()</code>
|
||
<div class="block">Search users.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i54" class="altColor">
|
||
<td class="colFirst"><code>void</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHub.html#setConnector-org.kohsuke.github.HttpConnector-">setConnector</a></span>(<a href="../../../org/kohsuke/github/HttpConnector.html" title="interface in org.kohsuke.github">HttpConnector</a> connector)</code>
|
||
<div class="block">Sets the custom connector used to make requests to GitHub.</div>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
||
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="details">
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<!-- ============ METHOD DETAIL ========== -->
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="method.detail">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Method Detail</h3>
|
||
<a name="connect--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connect</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connect()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Obtains the credential from "~/.github" or from the System Environment Properties.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="connectToEnterprise-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connectToEnterprise</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connectToEnterprise(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> apiUrl,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../org/kohsuke/github/GitHub.html#connectToEnterpriseWithOAuth-java.lang.String-java.lang.String-java.lang.String-"><code>connectToEnterpriseWithOAuth(String, String, String)</code></a></span></div>
|
||
<div class="block">Version that connects to GitHub Enterprise.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="connectToEnterpriseWithOAuth-java.lang.String-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connectToEnterpriseWithOAuth</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connectToEnterpriseWithOAuth(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> apiUrl,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">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 <tt>/api/v3</tt> in the URL.
|
||
For historical reasons, this parameter still accepts the bare domain name, but that's considered deprecated.</dd>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="connectToEnterprise-java.lang.String-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connectToEnterprise</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connectToEnterprise(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> apiUrl,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use with caution. Login with password is not a preferred method.</span></div>
|
||
<div class="block">Version that connects to GitHub Enterprise.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="connect-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connect</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connect(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="connect-java.lang.String-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connect</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connect(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Either OAuth token or password is sufficient, so there's no point in passing both.
|
||
Use <a href="../../../org/kohsuke/github/GitHub.html#connectUsingPassword-java.lang.String-java.lang.String-"><code>connectUsingPassword(String, String)</code></a> or <a href="../../../org/kohsuke/github/GitHub.html#connectUsingOAuth-java.lang.String-"><code>connectUsingOAuth(String)</code></a>.</span></div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="connectUsingPassword-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connectUsingPassword</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connectUsingPassword(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="connectUsingOAuth-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connectUsingOAuth</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connectUsingOAuth(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="connectUsingOAuth-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connectUsingOAuth</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connectUsingOAuth(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> githubServer,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oauthAccessToken)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="connectAnonymously--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connectAnonymously</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connectAnonymously()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Connects to GitHub anonymously.
|
||
|
||
All operations that requires authentication will fail.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="connectToEnterpriseAnonymously-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>connectToEnterpriseAnonymously</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> connectToEnterpriseAnonymously(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> apiUrl)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Connects to GitHub Enterprise anonymously.
|
||
|
||
All operations that requires authentication will fail.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="offline--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>offline</h4>
|
||
<pre>public static <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a> offline()</pre>
|
||
<div class="block">An offline-only <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github"><code>GitHub</code></a> useful for parsing event notification from an unknown source.
|
||
|
||
All operations that require a connection will fail.</div>
|
||
<dl>
|
||
<dt><span class="returnLabel">Returns:</span></dt>
|
||
<dd>An offline-only <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github"><code>GitHub</code></a>.</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="isAnonymous--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>isAnonymous</h4>
|
||
<pre>public boolean 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 name="isOffline--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>isOffline</h4>
|
||
<pre>public boolean 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 name="getConnector--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getConnector</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/HttpConnector.html" title="interface in org.kohsuke.github">HttpConnector</a> getConnector()</pre>
|
||
</li>
|
||
</ul>
|
||
<a name="getApiUrl--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getApiUrl</h4>
|
||
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getApiUrl()</pre>
|
||
</li>
|
||
</ul>
|
||
<a name="setConnector-org.kohsuke.github.HttpConnector-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>setConnector</h4>
|
||
<pre>public void setConnector(<a href="../../../org/kohsuke/github/HttpConnector.html" title="interface in org.kohsuke.github">HttpConnector</a> connector)</pre>
|
||
<div class="block">Sets the custom connector used to make requests to GitHub.</div>
|
||
</li>
|
||
</ul>
|
||
<a name="getRateLimit--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getRateLimit</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a> getRateLimit()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Gets the current rate limit.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="lastRateLimit--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>lastRateLimit</h4>
|
||
<pre>@CheckForNull
|
||
public <a href="../../../org/kohsuke/github/GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a> 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 name="rateLimit--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>rateLimit</h4>
|
||
<pre>@Nonnull
|
||
public <a href="../../../org/kohsuke/github/GHRateLimit.html" title="class in org.kohsuke.github">GHRateLimit</a> rateLimit()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">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="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if we couldn't get the current rate limit data.</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="getMyself--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getMyself</h4>
|
||
<pre>@WithBridgeMethods(value=<a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser.class</a>)
|
||
public <a href="../../../org/kohsuke/github/GHMyself.html" title="class in org.kohsuke.github">GHMyself</a> getMyself()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Gets the <a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github"><code>GHUser</code></a> that represents yourself.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="getUser-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getUser</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a> getUser(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> login)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Obtains the object that represents the named user.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="refreshCache--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>refreshCache</h4>
|
||
<pre>public void refreshCache()</pre>
|
||
<div class="block">clears all cached data in order for external changes (modifications and del</div>
|
||
</li>
|
||
</ul>
|
||
<a name="getUser-org.kohsuke.github.GHUser-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getUser</h4>
|
||
<pre>protected <a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a> getUser(<a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a> orig)</pre>
|
||
<div class="block">Interns the given <a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github"><code>GHUser</code></a>.</div>
|
||
</li>
|
||
</ul>
|
||
<a name="getOrganization-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getOrganization</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a> getOrganization(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Gets <a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github"><code>GHOrganization</code></a> specified by name.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="listOrganizations--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>listOrganizations</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>> listOrganizations()</pre>
|
||
<div class="block">Gets a list of all organizations.</div>
|
||
</li>
|
||
</ul>
|
||
<a name="listOrganizations-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>listOrganizations</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>> listOrganizations(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> since)</pre>
|
||
<div class="block">Gets a list of all organizations starting after the organization identifier specified by 'since'.</div>
|
||
<dl>
|
||
<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 name="getRepository-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getRepository</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHRepository.html" title="class in org.kohsuke.github">GHRepository</a> getRepository(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">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="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
<dt><span class="seeLabel">See Also:</span></dt>
|
||
<dd><a href="../../../org/kohsuke/github/GHRepository.html#getName--"><code>GHRepository.getName()</code></a></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="listLicenses--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>listLicenses</h4>
|
||
<pre><a href="../../../org/kohsuke/github/Preview.html" title="annotation in org.kohsuke.github">@Preview</a>
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
||
public <a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHLicense.html" title="class in org.kohsuke.github">GHLicense</a>> listLicenses()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
|
||
<div class="block">Returns a list of popular open source licenses
|
||
|
||
WARNING: This uses a PREVIEW API.</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="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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 name="listUsers--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>listUsers</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHUser.html" title="class in org.kohsuke.github">GHUser</a>> listUsers()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Returns a list of all users.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="getLicense-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getLicense</h4>
|
||
<pre><a href="../../../org/kohsuke/github/Preview.html" title="annotation in org.kohsuke.github">@Preview</a>
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
||
public <a href="../../../org/kohsuke/github/GHLicense.html" title="class in org.kohsuke.github">GHLicense</a> getLicense(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
|
||
<div class="block">Returns the full details for a license
|
||
|
||
WARNING: This uses a PREVIEW API.</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="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
<dt><span class="seeLabel">See Also:</span></dt>
|
||
<dd><a href="../../../org/kohsuke/github/GHLicense.html#getKey--"><code>GHLicense.getKey()</code></a></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="getMyOrganizations--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getMyOrganizations</h4>
|
||
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../org/kohsuke/github/GHOrganization.html" title="class in org.kohsuke.github">GHOrganization</a>> getMyOrganizations()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">/**
|
||
This method returns a shallowly populated organizations.
|
||
|
||
To retrieve full organization details, you need to call <a href="../../../org/kohsuke/github/GitHub.html#getOrganization-java.lang.String-"><code>getOrganization(String)</code></a>
|
||
TODO: make this automatic.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="getMyTeams--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getMyTeams</h4>
|
||
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../org/kohsuke/github/GHTeam.html" title="class in org.kohsuke.github">GHTeam</a>>> getMyTeams()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Gets complete map of organizations/teams that current user belongs to.
|
||
|
||
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="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="getEvents--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getEvents</h4>
|
||
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/kohsuke/github/GHEventInfo.html" title="class in org.kohsuke.github">GHEventInfo</a>> getEvents()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">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="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="getGist-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getGist</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHGist.html" title="class in org.kohsuke.github">GHGist</a> getGist(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Gets a sigle gist by ID.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="createGist--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>createGist</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHGistBuilder.html" title="class in org.kohsuke.github">GHGistBuilder</a> createGist()</pre>
|
||
</li>
|
||
</ul>
|
||
<a name="parseEventPayload-java.io.Reader-java.lang.Class-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>parseEventPayload</h4>
|
||
<pre>public <T extends <a href="../../../org/kohsuke/github/GHEventPayload.html" title="class in org.kohsuke.github">GHEventPayload</a>> T parseEventPayload(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> r,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Parses the GitHub event object.
|
||
|
||
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="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="createRepository-java.lang.String-java.lang.String-java.lang.String-boolean-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>createRepository</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHRepository.html" title="class in org.kohsuke.github">GHRepository</a> createRepository(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> homepage,
|
||
boolean isPublic)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../org/kohsuke/github/GitHub.html#createRepository-java.lang.String-"><code>createRepository(String)</code></a> that uses a builder pattern to let you control every aspect.</span></div>
|
||
<div class="block">Creates a new repository.</div>
|
||
<dl>
|
||
<dt><span class="returnLabel">Returns:</span></dt>
|
||
<dd>Newly created repository.</dd>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="createRepository-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>createRepository</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHCreateRepositoryBuilder.html" title="class in org.kohsuke.github">GHCreateRepositoryBuilder</a> createRepository(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> 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="../../../org/kohsuke/github/GHCreateRepositoryBuilder.html#create--"><code>GHCreateRepositoryBuilder.create()</code></a>
|
||
to finally createa repository.
|
||
|
||
<p>
|
||
To create a repository in an organization, see
|
||
<a href="../../../org/kohsuke/github/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>
|
||
</li>
|
||
</ul>
|
||
<a name="createToken-java.util.Collection-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>createToken</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a> createToken(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> scope,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> note,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> noteUrl)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Creates a new authorization.
|
||
|
||
The token created can be then used for <a href="../../../org/kohsuke/github/GitHub.html#connectUsingOAuth-java.lang.String-"><code>connectUsingOAuth(String)</code></a> in the future.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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 name="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>public <a href="../../../org/kohsuke/github/GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a> createOrGetAuth(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientSecret,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> scopes,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> note,
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> note_url)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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 name="deleteAuth-long-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>deleteAuth</h4>
|
||
<pre>public void deleteAuth(long id)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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 name="checkAuth-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>checkAuth</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a> checkAuth(@Nonnull
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId,
|
||
@Nonnull
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> accessToken)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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 name="resetAuth-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>resetAuth</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHAuthorization.html" title="class in org.kohsuke.github">GHAuthorization</a> resetAuth(@Nonnull
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId,
|
||
@Nonnull
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> accessToken)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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 name="isCredentialValid--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>isCredentialValid</h4>
|
||
<pre>public boolean isCredentialValid()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
||
<div class="block">Ensures that the credential is valid.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="checkApiUrlValidity--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>checkApiUrlValidity</h4>
|
||
<pre>public void checkApiUrlValidity()
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">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="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> to indicate the problem.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="searchCommits--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>searchCommits</h4>
|
||
<pre><a href="../../../org/kohsuke/github/Preview.html" title="annotation in org.kohsuke.github">@Preview</a>
|
||
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
||
public <a href="../../../org/kohsuke/github/GHCommitSearchBuilder.html" title="class in org.kohsuke.github">GHCommitSearchBuilder</a> searchCommits()</pre>
|
||
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
|
||
<div class="block">Search commits.</div>
|
||
</li>
|
||
</ul>
|
||
<a name="searchIssues--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>searchIssues</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHIssueSearchBuilder.html" title="class in org.kohsuke.github">GHIssueSearchBuilder</a> searchIssues()</pre>
|
||
<div class="block">Search issues.</div>
|
||
</li>
|
||
</ul>
|
||
<a name="searchUsers--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>searchUsers</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHUserSearchBuilder.html" title="class in org.kohsuke.github">GHUserSearchBuilder</a> searchUsers()</pre>
|
||
<div class="block">Search users.</div>
|
||
</li>
|
||
</ul>
|
||
<a name="searchRepositories--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>searchRepositories</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHRepositorySearchBuilder.html" title="class in org.kohsuke.github">GHRepositorySearchBuilder</a> searchRepositories()</pre>
|
||
<div class="block">Search repositories.</div>
|
||
</li>
|
||
</ul>
|
||
<a name="searchContent--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>searchContent</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHContentSearchBuilder.html" title="class in org.kohsuke.github">GHContentSearchBuilder</a> searchContent()</pre>
|
||
<div class="block">Search content.</div>
|
||
</li>
|
||
</ul>
|
||
<a name="listNotifications--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>listNotifications</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a> listNotifications()</pre>
|
||
<div class="block">List all the notifications.</div>
|
||
</li>
|
||
</ul>
|
||
<a name="listAllPublicRepositories--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>listAllPublicRepositories</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>> 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="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 name="listAllPublicRepositories-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>listAllPublicRepositories</h4>
|
||
<pre>public <a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>> listAllPublicRepositories(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> 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="../../../org/kohsuke/github/GHObject.html#getId--"><code>GHObject.getId()</code></a></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 name="renderMarkdown-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockListLast">
|
||
<li class="blockList">
|
||
<h4>renderMarkdown</h4>
|
||
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> renderMarkdown(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text)
|
||
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">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="throwsLabel">Throws:</span></dt>
|
||
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
|
||
<dt><span class="seeLabel">See Also:</span></dt>
|
||
<dd><a href="../../../org/kohsuke/github/GHRepository.html#renderMarkdown-java.lang.String-org.kohsuke.github.MarkdownMode-"><code>GHRepository.renderMarkdown(String, MarkdownMode)</code></a></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<!-- ========= END OF CLASS DATA ========= -->
|
||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
<div class="bottomNav"><a name="navbar.bottom">
|
||
<!-- -->
|
||
</a>
|
||
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
||
<a name="navbar.bottom.firstrow">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="navList" title="Navigation">
|
||
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
<li><a href="package-summary.html">Package</a></li>
|
||
<li class="navBarCell1Rev">Class</li>
|
||
<li><a href="class-use/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">
|
||
<li><a href="../../../org/kohsuke/github/GHVerifiedKey.html" title="class in org.kohsuke.github"><span class="typeNameLink">Prev Class</span></a></li>
|
||
<li><a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github"><span class="typeNameLink">Next Class</span></a></li>
|
||
</ul>
|
||
<ul class="navList">
|
||
<li><a href="../../../index.html?org/kohsuke/github/GitHub.html" target="_top">Frames</a></li>
|
||
<li><a href="GitHub.html" target="_top">No Frames</a></li>
|
||
</ul>
|
||
<ul class="navList" id="allclasses_navbar_bottom">
|
||
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
||
</ul>
|
||
<div>
|
||
<script type="text/javascript"><!--
|
||
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
||
if(window==top) {
|
||
allClassesLink.style.display = "block";
|
||
}
|
||
else {
|
||
allClassesLink.style.display = "none";
|
||
}
|
||
//-->
|
||
</script>
|
||
</div>
|
||
<div>
|
||
<ul class="subNavList">
|
||
<li>Summary: </li>
|
||
<li>Nested | </li>
|
||
<li>Field | </li>
|
||
<li>Constr | </li>
|
||
<li><a href="#method.summary">Method</a></li>
|
||
</ul>
|
||
<ul class="subNavList">
|
||
<li>Detail: </li>
|
||
<li>Field | </li>
|
||
<li>Constr | </li>
|
||
<li><a href="#method.detail">Method</a></li>
|
||
</ul>
|
||
</div>
|
||
<a name="skip.navbar.bottom">
|
||
<!-- -->
|
||
</a></div>
|
||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
<p class="legalCopy"><small>Copyright © 2018. All rights reserved.</small></p>
|
||
</body>
|
||
</html>
|