jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-03-10 15:49:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
27a7b57443f6ff486d821a1879782e28ca6bf86a
github-api/apidocs/org/kohsuke/github/GHNotificationStream.html
Kohsuke Kawaguchi 27a7b57443 Wagon: Deploying site to repository
2015-12-01 16:33:50 +01:00

372 lines
18 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 (version 1.7.0_15) on Tue Dec 01 16:33:04 CET 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>GHNotificationStream (GitHub API for Java 1.71 API)</title>
<meta name="date" content="2015-12-01">
<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.71 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.RepositoryListFilter.html" title="enum 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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a 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><a href="http://java.sun.com/j2se/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.GHNotificationStream</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github">GHThread</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">GHNotificationStream</span>
extends <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github">GHThread</a>&gt;</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 <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true#next()" title="class or interface in java.util"><code>Iterator.next()</code></a> 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">&nbsp;</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><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github">GHThread</a>&gt;</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 <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> 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>&nbsp;</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&nbsp;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&nbsp;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&nbsp;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&nbsp;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>(<a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;dt)</code>&nbsp;</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&nbsp;timestamp)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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="read(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a>&nbsp;read(boolean&nbsp;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&nbsp;<a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a>&nbsp;participating(boolean&nbsp;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&nbsp;<a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a>&nbsp;since(long&nbsp;timestamp)</pre>
</li>
</ul>
<a name="since(java.util.Date)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>since</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a>&nbsp;since(<a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;dt)</pre>
</li>
</ul>
<a name="nonBlocking(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nonBlocking</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHNotificationStream.html" title="class in org.kohsuke.github">GHNotificationStream</a>&nbsp;nonBlocking(boolean&nbsp;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&nbsp;<a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github">GHThread</a>&gt;&nbsp;iterator()</pre>
<div class="block">Returns an infinite blocking <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> 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><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../org/kohsuke/github/GHThread.html" title="class in org.kohsuke.github">GHThread</a>&gt;</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 <a href="http://java.sun.com/j2se/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="strong">Throws:</span></dt>
<dd><code><a href="http://java.sun.com/j2se/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="markAsRead(long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>markAsRead</h4>
<pre>public&nbsp;void&nbsp;markAsRead(long&nbsp;timestamp)
throws <a href="http://java.sun.com/j2se/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">Marks all the notifications as read.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://java.sun.com/j2se/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>
</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.RepositoryListFilter.html" title="enum 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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015. All Rights Reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink