mirror of
https://github.com/jlengrand/github-api.git
synced 2026-05-09 00:11:24 +00:00
Wagon: Deploying site to repository
This commit is contained in:
Kohsuke Kawaguchi
371
apidocs/org/kohsuke/github/GHNotificationStream.html
Normal file
371
apidocs/org/kohsuke/github/GHNotificationStream.html
Normal file
@@ -0,0 +1,371 @@
|
||||
<!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 (version 1.7.0_07) on Tue Mar 24 13:04:48 PDT 2015 -->
|
||||
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
|
||||
<title>GHNotificationStream (GitHub API for Java 1.66 API)</title>
|
||||
<meta name="date" content="2015-03-24">
|
||||
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body>
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="GHNotificationStream (GitHub API for Java 1.66 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="topNav"><a name="navbar_top">
|
||||
<!-- -->
|
||||
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/GHNotificationStream.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/GHMyself.html" title="class in org.kohsuke.github"><span class="strong">Prev Class</span></a></li>
|
||||
<li><a href="../../../org/kohsuke/github/GHObject.html" title="class in org.kohsuke.github"><span class="strong">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../index.html?org/kohsuke/github/GHNotificationStream.html" target="_top">Frames</a></li>
|
||||
<li><a href="GHNotificationStream.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 GHNotificationStream" class="title">Class GHNotificationStream</h2>
|
||||
</div>
|
||||
<div class="contentContainer">
|
||||
<ul class="inheritance">
|
||||
<li>java.lang.Object</li>
|
||||
<li>
|
||||
<ul class="inheritance">
|
||||
<li>org.kohsuke.github.GHNotificationStream</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="description">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<dl>
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd>java.lang.Iterable<<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github">GHThread</a>></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<br>
|
||||
<pre>public class <span class="strong">GHNotificationStream</span>
|
||||
extends java.lang.Object
|
||||
implements java.lang.Iterable<<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github">GHThread</a>></pre>
|
||||
<div class="block">Listens to GitHub notification stream.
|
||||
|
||||
<p>
|
||||
This class supports two modes of retrieving notifications that can
|
||||
be controlled via <a href="../../../org/kohsuke/github/GHNotificationStream.html#nonBlocking(boolean)"><code>nonBlocking(boolean)</code></a>.
|
||||
|
||||
<p>
|
||||
In the blocking mode, which is the default, iterator will be infinite.
|
||||
The call to <code>Iterator.next()</code> will block until a new notification
|
||||
arrives. This is useful for application that runs perpetually and reacts
|
||||
to notifications.
|
||||
|
||||
<p>
|
||||
In the non-blocking mode, the iterator will only report the set of
|
||||
notifications initially retrieved from GitHub, then quit. This is useful
|
||||
for a batch application to process the current set of notifications.</div>
|
||||
<dl><dt><span class="strong">Author:</span></dt>
|
||||
<dd>Kohsuke Kawaguchi</dd>
|
||||
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/kohsuke/github/GitHub.html#listNotifications()"><code>GitHub.listNotifications()</code></a>,
|
||||
<a href="../../../org/kohsuke/github/GHRepository.html#listNotifications()"><code>GHRepository.listNotifications()</code></a></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||||
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||||
<th class="colLast" scope="col">Method and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>java.util.Iterator<<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github">GHThread</a>></code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../org/kohsuke/github/GHNotificationStream.html#iterator()">iterator</a></strong>()</code>
|
||||
<div class="block">Returns an infinite blocking <code>Iterator</code> that returns
|
||||
<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github"><code>GHThread</code></a> as notifications arrive.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../org/kohsuke/github/GHNotificationStream.html#markAsRead()">markAsRead</a></strong>()</code> </td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><strong><a href="../../../org/kohsuke/github/GHNotificationStream.html#markAsRead(long)">markAsRead</a></strong>(long timestamp)</code>
|
||||
<div class="block">Marks all the notifications as read.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr 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><strong><a href="../../../org/kohsuke/github/GHNotificationStream.html#nonBlocking(boolean)">nonBlocking</a></strong>(boolean v)</code>
|
||||
<div class="block">If set to true, <a href="../../../org/kohsuke/github/GHNotificationStream.html#iterator()"><code>iterator()</code></a> will stop iterating instead of blocking and
|
||||
waiting for the updates to arrive.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<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><strong><a href="../../../org/kohsuke/github/GHNotificationStream.html#participating(boolean)">participating</a></strong>(boolean v)</code>
|
||||
<div class="block">Should the stream be restricted to notifications in which the user
|
||||
is directly participating or mentioned?</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr 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><strong><a href="../../../org/kohsuke/github/GHNotificationStream.html#read(boolean)">read</a></strong>(boolean v)</code>
|
||||
<div class="block">Should the stream include notifications that are already read?</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<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><strong><a href="../../../org/kohsuke/github/GHNotificationStream.html#since(java.util.Date)">since</a></strong>(java.util.Date dt)</code> </td>
|
||||
</tr>
|
||||
<tr 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><strong><a href="../../../org/kohsuke/github/GHNotificationStream.html#since(long)">since</a></strong>(long timestamp)</code> </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.Object</h3>
|
||||
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="read(boolean)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>read</h4>
|
||||
<pre>public <a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a> read(boolean v)</pre>
|
||||
<div class="block">Should the stream include notifications that are already read?</div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="participating(boolean)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>participating</h4>
|
||||
<pre>public <a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a> participating(boolean v)</pre>
|
||||
<div class="block">Should the stream be restricted to notifications in which the user
|
||||
is directly participating or mentioned?</div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="since(long)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>since</h4>
|
||||
<pre>public <a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a> since(long timestamp)</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="since(java.util.Date)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>since</h4>
|
||||
<pre>public <a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a> since(java.util.Date dt)</pre>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="nonBlocking(boolean)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>nonBlocking</h4>
|
||||
<pre>public <a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a> nonBlocking(boolean v)</pre>
|
||||
<div class="block">If set to true, <a href="../../../org/kohsuke/github/GHNotificationStream.html#iterator()"><code>iterator()</code></a> will stop iterating instead of blocking and
|
||||
waiting for the updates to arrive.</div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="iterator()">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>iterator</h4>
|
||||
<pre>public java.util.Iterator<<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github">GHThread</a>> iterator()</pre>
|
||||
<div class="block">Returns an infinite blocking <code>Iterator</code> that returns
|
||||
<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github"><code>GHThread</code></a> as notifications arrive.</div>
|
||||
<dl>
|
||||
<dt><strong>Specified by:</strong></dt>
|
||||
<dd><code>iterator</code> in interface <code>java.lang.Iterable<<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github">GHThread</a>></code></dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="markAsRead()">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>markAsRead</h4>
|
||||
<pre>public void markAsRead()
|
||||
throws java.io.IOException</pre>
|
||||
<dl><dt><span class="strong">Throws:</span></dt>
|
||||
<dd><code>java.io.IOException</code></dd></dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="markAsRead(long)">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>markAsRead</h4>
|
||||
<pre>public void markAsRead(long timestamp)
|
||||
throws java.io.IOException</pre>
|
||||
<div class="block">Marks all the notifications as read.</div>
|
||||
<dl><dt><span class="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/GHNotificationStream.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/GHMyself.html" title="class in org.kohsuke.github"><span class="strong">Prev Class</span></a></li>
|
||||
<li><a href="../../../org/kohsuke/github/GHObject.html" title="class in org.kohsuke.github"><span class="strong">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../index.html?org/kohsuke/github/GHNotificationStream.html" target="_top">Frames</a></li>
|
||||
<li><a href="GHNotificationStream.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 © 2015. All Rights Reserved.</small></p>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user