Skip to content

Commit

Permalink
docs for presence operation
Browse files Browse the repository at this point in the history
  • Loading branch information
Max Presman committed Dec 19, 2017
1 parent d5ac8d2 commit 486f9b5
Show file tree
Hide file tree
Showing 3 changed files with 928 additions and 0 deletions.
332 changes: 332 additions & 0 deletions docs/com/pubnub/api/builder/PresenceBuilder.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,332 @@
<!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 -->
<title>PresenceBuilder (pubnub-gson 4.17.0 API)</title>
<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="PresenceBuilder (pubnub-gson 4.17.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="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>Prev&nbsp;Class</li>
<li><a href="../../../../com/pubnub/api/builder/PubNubErrorBuilder.html" title="class in com.pubnub.api.builder"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/pubnub/api/builder/PresenceBuilder.html" target="_top">Frames</a></li>
<li><a href="PresenceBuilder.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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">com.pubnub.api.builder</div>
<h2 title="Class PresenceBuilder" class="title">Class PresenceBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/pubnub/api/builder/PubSubBuilder.html" title="class in com.pubnub.api.builder">com.pubnub.api.builder.PubSubBuilder</a></li>
<li>
<ul class="inheritance">
<li>com.pubnub.api.builder.PresenceBuilder</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">PresenceBuilder</span>
extends <a href="../../../../com/pubnub/api/builder/PubSubBuilder.html" title="class in com.pubnub.api.builder">PubSubBuilder</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html#PresenceBuilder-com.pubnub.api.managers.SubscriptionManager-">PresenceBuilder</a></span>(<a href="../../../../com/pubnub/api/managers/SubscriptionManager.html" title="class in com.pubnub.api.managers">SubscriptionManager</a>&nbsp;subscriptionManager)</code>&nbsp;</td>
</tr>
</table>
</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></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="../../../../com/pubnub/api/builder/PresenceBuilder.html" title="class in com.pubnub.api.builder">PresenceBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html#channelGroups-java.util.List-">channelGroups</a></span>(java.util.List&lt;java.lang.String&gt;&nbsp;channelGroups)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html" title="class in com.pubnub.api.builder">PresenceBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html#channels-java.util.List-">channels</a></span>(java.util.List&lt;java.lang.String&gt;&nbsp;channels)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html" title="class in com.pubnub.api.builder">PresenceBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html#connected-boolean-">connected</a></span>(boolean&nbsp;connected)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html#execute--">execute</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.pubnub.api.builder.PubSubBuilder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.pubnub.api.builder.<a href="../../../../com/pubnub/api/builder/PubSubBuilder.html" title="class in com.pubnub.api.builder">PubSubBuilder</a></h3>
<code><a href="../../../../com/pubnub/api/builder/PubSubBuilder.html#getChannelGroupSubscriptions--">getChannelGroupSubscriptions</a>, <a href="../../../../com/pubnub/api/builder/PubSubBuilder.html#getChannelSubscriptions--">getChannelSubscriptions</a>, <a href="../../../../com/pubnub/api/builder/PubSubBuilder.html#getSubscriptionManager--">getSubscriptionManager</a>, <a href="../../../../com/pubnub/api/builder/PubSubBuilder.html#setChannelGroupSubscriptions-java.util.List-">setChannelGroupSubscriptions</a>, <a href="../../../../com/pubnub/api/builder/PubSubBuilder.html#setChannelSubscriptions-java.util.List-">setChannelSubscriptions</a>, <a href="../../../../com/pubnub/api/builder/PubSubBuilder.html#setSubscriptionManager-com.pubnub.api.managers.SubscriptionManager-">setSubscriptionManager</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, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PresenceBuilder-com.pubnub.api.managers.SubscriptionManager-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PresenceBuilder</h4>
<pre>public&nbsp;PresenceBuilder(<a href="../../../../com/pubnub/api/managers/SubscriptionManager.html" title="class in com.pubnub.api.managers">SubscriptionManager</a>&nbsp;subscriptionManager)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="execute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;void&nbsp;execute()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/pubnub/api/builder/PubSubBuilder.html#execute--">execute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/pubnub/api/builder/PubSubBuilder.html" title="class in com.pubnub.api.builder">PubSubBuilder</a></code></dd>
</dl>
</li>
</ul>
<a name="channels-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>channels</h4>
<pre>public&nbsp;<a href="../../../../com/pubnub/api/builder/PresenceBuilder.html" title="class in com.pubnub.api.builder">PresenceBuilder</a>&nbsp;channels(java.util.List&lt;java.lang.String&gt;&nbsp;channels)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/pubnub/api/builder/PubSubBuilder.html#channels-java.util.List-">channels</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/pubnub/api/builder/PubSubBuilder.html" title="class in com.pubnub.api.builder">PubSubBuilder</a></code></dd>
</dl>
</li>
</ul>
<a name="channelGroups-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>channelGroups</h4>
<pre>public&nbsp;<a href="../../../../com/pubnub/api/builder/PresenceBuilder.html" title="class in com.pubnub.api.builder">PresenceBuilder</a>&nbsp;channelGroups(java.util.List&lt;java.lang.String&gt;&nbsp;channelGroups)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/pubnub/api/builder/PubSubBuilder.html#channelGroups-java.util.List-">channelGroups</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/pubnub/api/builder/PubSubBuilder.html" title="class in com.pubnub.api.builder">PubSubBuilder</a></code></dd>
</dl>
</li>
</ul>
<a name="connected-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>connected</h4>
<pre>@Generated(value="lombok")
public&nbsp;<a href="../../../../com/pubnub/api/builder/PresenceBuilder.html" title="class in com.pubnub.api.builder">PresenceBuilder</a>&nbsp;connected(boolean&nbsp;connected)</pre>
</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="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>Prev&nbsp;Class</li>
<li><a href="../../../../com/pubnub/api/builder/PubNubErrorBuilder.html" title="class in com.pubnub.api.builder"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/pubnub/api/builder/PresenceBuilder.html" target="_top">Frames</a></li>
<li><a href="PresenceBuilder.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Loading

0 comments on commit 486f9b5

Please sign in to comment.