jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-05-09 08:21:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
bd444e6043f56726501bd0fb3184e3fbd04da714
github-api/apidocs/org/kohsuke/github/GHThread.html
Kohsuke Kawaguchi bd444e6043 Wagon: Deploying site to repository
2016-10-24 19:27:32 -07:00

516 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0) on Mon Oct 24 19:27:04 PDT 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GHThread (GitHub API for Java 1.79 API)</title>
<meta name="date" content="2016-10-24">
<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="GHThread (GitHub API for Java 1.79 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GHThread.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/GHTeam.html" title="class in org.kohsuke.github"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/kohsuke/github/GHTree.html" title="class in org.kohsuke.github"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/github/GHThread.html" target="_top">Frames</a></li>
<li><a href="GHThread.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.kohsuke.github.GHObject">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a 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 GHThread" class="title">Class GHThread</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../org/kohsuke/github/GHObject.html" title="class in org.kohsuke.github">org.kohsuke.github.GHObject</a></li>
<li>
<ul class="inheritance">
<li>org.kohsuke.github.GHThread</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">GHThread</span>
extends <a href="../../../org/kohsuke/github/GHObject.html" title="class in org.kohsuke.github">GHObject</a></pre>
<div class="block">A conversation in the notification API.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Kohsuke Kawaguchi</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.github.com/v3/activity/notifications/">documentation</a>,
<a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github"><code>GHNotificationStream</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.kohsuke.github.GHObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.kohsuke.github.<a href="../../../org/kohsuke/github/GHObject.html" title="class in org.kohsuke.github">GHObject</a></h3>
<code><a href="../../../org/kohsuke/github/GHObject.html#created_at">created_at</a>, <a href="../../../org/kohsuke/github/GHObject.html#id">id</a>, <a href="../../../org/kohsuke/github/GHObject.html#updated_at">updated_at</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommit.html" title="class in org.kohsuke.github">GHCommit</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#getBoundCommit--">getBoundCommit</a></span>()</code>
<div class="block">If this thread is about a commit, return that commit.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#getBoundIssue--">getBoundIssue</a></span>()</code>
<div class="block">If this thread is about an issue, return that issue.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#getBoundPullRequest--">getBoundPullRequest</a></span>()</code>
<div class="block">If this thread is about a pull request, return that pull request.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.net.URL</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#getHtmlUrl--">getHtmlUrl</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This object has no HTML URL.</span></div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#getLastCommentUrl--">getLastCommentUrl</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#getLastReadAt--">getLastReadAt</a></span>()</code>
<div class="block">Returns null if the entire thread has never been read.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#getReason--">getReason</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" 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/GHThread.html#getRepository--">getRepository</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHSubscription.html" title="class in org.kohsuke.github">GHSubscription</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#getSubscription--">getSubscription</a></span>()</code>
<div class="block">Returns the current subscription for this thread.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#getTitle--">getTitle</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#getType--">getType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#isRead--">isRead</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#markAsRead--">markAsRead</a></span>()</code>
<div class="block">Marks this thread as read.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHSubscription.html" title="class in org.kohsuke.github">GHSubscription</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHThread.html#subscribe-boolean-boolean-">subscribe</a></span>(boolean&nbsp;subscribed,
boolean&nbsp;ignored)</code>
<div class="block">Subscribes to this conversation to get notifications.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.kohsuke.github.GHObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.kohsuke.github.<a href="../../../org/kohsuke/github/GHObject.html" title="class in org.kohsuke.github">GHObject</a></h3>
<code><a href="../../../org/kohsuke/github/GHObject.html#getCreatedAt--">getCreatedAt</a>, <a href="../../../org/kohsuke/github/GHObject.html#getId--">getId</a>, <a href="../../../org/kohsuke/github/GHObject.html#getUpdatedAt--">getUpdatedAt</a>, <a href="../../../org/kohsuke/github/GHObject.html#getUrl--">getUrl</a>, <a href="../../../org/kohsuke/github/GHObject.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLastReadAt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastReadAt</h4>
<pre>public&nbsp;java.util.Date&nbsp;getLastReadAt()</pre>
<div class="block">Returns null if the entire thread has never been read.</div>
</li>
</ul>
<a name="getHtmlUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHtmlUrl</h4>
<pre>public&nbsp;java.net.URL&nbsp;getHtmlUrl()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This object has no HTML URL.</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../org/kohsuke/github/GHObject.html#getHtmlUrl--">GHObject</a></code></span></div>
<div class="block">URL of this object for humans, which renders some HTML.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/kohsuke/github/GHObject.html#getHtmlUrl--">getHtmlUrl</a></code>&nbsp;in class&nbsp;<code><a href="../../../org/kohsuke/github/GHObject.html" title="class in org.kohsuke.github">GHObject</a></code></dd>
</dl>
</li>
</ul>
<a name="getReason--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReason</h4>
<pre>public&nbsp;java.lang.String&nbsp;getReason()</pre>
</li>
</ul>
<a name="getRepository--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRepository</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>&nbsp;getRepository()</pre>
</li>
</ul>
<a name="isRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRead</h4>
<pre>public&nbsp;boolean&nbsp;isRead()</pre>
</li>
</ul>
<a name="getTitle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTitle</h4>
<pre>public&nbsp;java.lang.String&nbsp;getTitle()</pre>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;java.lang.String&nbsp;getType()</pre>
</li>
</ul>
<a name="getLastCommentUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastCommentUrl</h4>
<pre>public&nbsp;java.lang.String&nbsp;getLastCommentUrl()</pre>
</li>
</ul>
<a name="getBoundIssue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoundIssue</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHIssue.html" title="class in org.kohsuke.github">GHIssue</a>&nbsp;getBoundIssue()
throws java.io.IOException</pre>
<div class="block">If this thread is about an issue, return that issue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null if this thread is not about an issue.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getBoundPullRequest--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoundPullRequest</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a>&nbsp;getBoundPullRequest()
throws java.io.IOException</pre>
<div class="block">If this thread is about a pull request, return that pull request.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null if this thread is not about a pull request.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getBoundCommit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoundCommit</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommit.html" title="class in org.kohsuke.github">GHCommit</a>&nbsp;getBoundCommit()
throws java.io.IOException</pre>
<div class="block">If this thread is about a commit, return that commit.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null if this thread is not about a commit.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="markAsRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>markAsRead</h4>
<pre>public&nbsp;void&nbsp;markAsRead()
throws java.io.IOException</pre>
<div class="block">Marks this thread as read.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="subscribe-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subscribe</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHSubscription.html" title="class in org.kohsuke.github">GHSubscription</a>&nbsp;subscribe(boolean&nbsp;subscribed,
boolean&nbsp;ignored)
throws java.io.IOException</pre>
<div class="block">Subscribes to this conversation to get notifications.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getSubscription--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSubscription</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHSubscription.html" title="class in org.kohsuke.github">GHSubscription</a>&nbsp;getSubscription()
throws java.io.IOException</pre>
<div class="block">Returns the current subscription for this thread.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null if no subscription exists.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GHThread.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/GHTeam.html" title="class in org.kohsuke.github"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/kohsuke/github/GHTree.html" title="class in org.kohsuke.github"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/github/GHThread.html" target="_top">Frames</a></li>
<li><a href="GHThread.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.kohsuke.github.GHObject">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016. All Rights Reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink