Skip to content

Commit 486f9b5

Browse files
author
Max Presman
committed
docs for presence operation
1 parent d5ac8d2 commit 486f9b5

File tree

3 files changed

+928
-0
lines changed

3 files changed

+928
-0
lines changed

‎docs/com/pubnub/api/builder/PresenceBuilder.html‎

Lines changed: 332 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,332 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc -->
6+
<title>PresenceBuilder (pubnub-gson 4.17.0 API)</title>
7+
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
8+
<script type="text/javascript" src="../../../../script.js"></script>
9+
</head>
10+
<body>
11+
<script type="text/javascript"><!--
12+
try {
13+
if (location.href.indexOf('is-external=true') == -1) {
14+
parent.document.title="PresenceBuilder (pubnub-gson 4.17.0 API)";
15+
}
16+
}
17+
catch(err) {
18+
}
19+
//-->
20+
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
21+
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
22+
var altColor = "altColor";
23+
var rowColor = "rowColor";
24+
var tableTab = "tableTab";
25+
var activeTableTab = "activeTableTab";
26+
</script>
27+
<noscript>
28+
<div>JavaScript is disabled on your browser.</div>
29+
</noscript>
30+
<!-- ========= START OF TOP NAVBAR ======= -->
31+
<div class="topNav"><a name="navbar.top">
32+
<!-- -->
33+
</a>
34+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
35+
<a name="navbar.top.firstrow">
36+
<!-- -->
37+
</a>
38+
<ul class="navList" title="Navigation">
39+
<li><a href="../../../../overview-summary.html">Overview</a></li>
40+
<li><a href="package-summary.html">Package</a></li>
41+
<li class="navBarCell1Rev">Class</li>
42+
<li><a href="package-tree.html">Tree</a></li>
43+
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
44+
<li><a href="../../../../index-all.html">Index</a></li>
45+
<li><a href="../../../../help-doc.html">Help</a></li>
46+
</ul>
47+
</div>
48+
<div class="subNav">
49+
<ul class="navList">
50+
<li>Prev&nbsp;Class</li>
51+
<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>
52+
</ul>
53+
<ul class="navList">
54+
<li><a href="../../../../index.html?com/pubnub/api/builder/PresenceBuilder.html" target="_top">Frames</a></li>
55+
<li><a href="PresenceBuilder.html" target="_top">No&nbsp;Frames</a></li>
56+
</ul>
57+
<ul class="navList" id="allclasses_navbar_top">
58+
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
59+
</ul>
60+
<div>
61+
<script type="text/javascript"><!--
62+
allClassesLink = document.getElementById("allclasses_navbar_top");
63+
if(window==top) {
64+
allClassesLink.style.display = "block";
65+
}
66+
else {
67+
allClassesLink.style.display = "none";
68+
}
69+
//-->
70+
</script>
71+
</div>
72+
<div>
73+
<ul class="subNavList">
74+
<li>Summary:&nbsp;</li>
75+
<li>Nested&nbsp;|&nbsp;</li>
76+
<li>Field&nbsp;|&nbsp;</li>
77+
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
78+
<li><a href="#method.summary">Method</a></li>
79+
</ul>
80+
<ul class="subNavList">
81+
<li>Detail:&nbsp;</li>
82+
<li>Field&nbsp;|&nbsp;</li>
83+
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
84+
<li><a href="#method.detail">Method</a></li>
85+
</ul>
86+
</div>
87+
<a name="skip.navbar.top">
88+
<!-- -->
89+
</a></div>
90+
<!-- ========= END OF TOP NAVBAR ========= -->
91+
<!-- ======== START OF CLASS DATA ======== -->
92+
<div class="header">
93+
<div class="subTitle">com.pubnub.api.builder</div>
94+
<h2 title="Class PresenceBuilder" class="title">Class PresenceBuilder</h2>
95+
</div>
96+
<div class="contentContainer">
97+
<ul class="inheritance">
98+
<li>java.lang.Object</li>
99+
<li>
100+
<ul class="inheritance">
101+
<li><a href="../../../../com/pubnub/api/builder/PubSubBuilder.html" title="class in com.pubnub.api.builder">com.pubnub.api.builder.PubSubBuilder</a></li>
102+
<li>
103+
<ul class="inheritance">
104+
<li>com.pubnub.api.builder.PresenceBuilder</li>
105+
</ul>
106+
</li>
107+
</ul>
108+
</li>
109+
</ul>
110+
<div class="description">
111+
<ul class="blockList">
112+
<li class="blockList">
113+
<hr>
114+
<br>
115+
<pre>public class <span class="typeNameLabel">PresenceBuilder</span>
116+
extends <a href="../../../../com/pubnub/api/builder/PubSubBuilder.html" title="class in com.pubnub.api.builder">PubSubBuilder</a></pre>
117+
</li>
118+
</ul>
119+
</div>
120+
<div class="summary">
121+
<ul class="blockList">
122+
<li class="blockList">
123+
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
124+
<ul class="blockList">
125+
<li class="blockList"><a name="constructor.summary">
126+
<!-- -->
127+
</a>
128+
<h3>Constructor Summary</h3>
129+
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
130+
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
131+
<tr>
132+
<th class="colOne" scope="col">Constructor and Description</th>
133+
</tr>
134+
<tr class="altColor">
135+
<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>
136+
</tr>
137+
</table>
138+
</li>
139+
</ul>
140+
<!-- ========== METHOD SUMMARY =========== -->
141+
<ul class="blockList">
142+
<li class="blockList"><a name="method.summary">
143+
<!-- -->
144+
</a>
145+
<h3>Method Summary</h3>
146+
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
147+
<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>
148+
<tr>
149+
<th class="colFirst" scope="col">Modifier and Type</th>
150+
<th class="colLast" scope="col">Method and Description</th>
151+
</tr>
152+
<tr id="i0" class="altColor">
153+
<td class="colFirst"><code><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html" title="class in com.pubnub.api.builder">PresenceBuilder</a></code></td>
154+
<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>
155+
</tr>
156+
<tr id="i1" class="rowColor">
157+
<td class="colFirst"><code><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html" title="class in com.pubnub.api.builder">PresenceBuilder</a></code></td>
158+
<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>
159+
</tr>
160+
<tr id="i2" class="altColor">
161+
<td class="colFirst"><code><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html" title="class in com.pubnub.api.builder">PresenceBuilder</a></code></td>
162+
<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>
163+
</tr>
164+
<tr id="i3" class="rowColor">
165+
<td class="colFirst"><code>void</code></td>
166+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/pubnub/api/builder/PresenceBuilder.html#execute--">execute</a></span>()</code>&nbsp;</td>
167+
</tr>
168+
</table>
169+
<ul class="blockList">
170+
<li class="blockList"><a name="methods.inherited.from.class.com.pubnub.api.builder.PubSubBuilder">
171+
<!-- -->
172+
</a>
173+
<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>
174+
<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>
175+
</ul>
176+
<ul class="blockList">
177+
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
178+
<!-- -->
179+
</a>
180+
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
181+
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
182+
</ul>
183+
</li>
184+
</ul>
185+
</li>
186+
</ul>
187+
</div>
188+
<div class="details">
189+
<ul class="blockList">
190+
<li class="blockList">
191+
<!-- ========= CONSTRUCTOR DETAIL ======== -->
192+
<ul class="blockList">
193+
<li class="blockList"><a name="constructor.detail">
194+
<!-- -->
195+
</a>
196+
<h3>Constructor Detail</h3>
197+
<a name="PresenceBuilder-com.pubnub.api.managers.SubscriptionManager-">
198+
<!-- -->
199+
</a>
200+
<ul class="blockListLast">
201+
<li class="blockList">
202+
<h4>PresenceBuilder</h4>
203+
<pre>public&nbsp;PresenceBuilder(<a href="../../../../com/pubnub/api/managers/SubscriptionManager.html" title="class in com.pubnub.api.managers">SubscriptionManager</a>&nbsp;subscriptionManager)</pre>
204+
</li>
205+
</ul>
206+
</li>
207+
</ul>
208+
<!-- ============ METHOD DETAIL ========== -->
209+
<ul class="blockList">
210+
<li class="blockList"><a name="method.detail">
211+
<!-- -->
212+
</a>
213+
<h3>Method Detail</h3>
214+
<a name="execute--">
215+
<!-- -->
216+
</a>
217+
<ul class="blockList">
218+
<li class="blockList">
219+
<h4>execute</h4>
220+
<pre>public&nbsp;void&nbsp;execute()</pre>
221+
<dl>
222+
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
223+
<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>
224+
</dl>
225+
</li>
226+
</ul>
227+
<a name="channels-java.util.List-">
228+
<!-- -->
229+
</a>
230+
<ul class="blockList">
231+
<li class="blockList">
232+
<h4>channels</h4>
233+
<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>
234+
<dl>
235+
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
236+
<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>
237+
</dl>
238+
</li>
239+
</ul>
240+
<a name="channelGroups-java.util.List-">
241+
<!-- -->
242+
</a>
243+
<ul class="blockList">
244+
<li class="blockList">
245+
<h4>channelGroups</h4>
246+
<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>
247+
<dl>
248+
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
249+
<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>
250+
</dl>
251+
</li>
252+
</ul>
253+
<a name="connected-boolean-">
254+
<!-- -->
255+
</a>
256+
<ul class="blockListLast">
257+
<li class="blockList">
258+
<h4>connected</h4>
259+
<pre>@Generated(value="lombok")
260+
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>
261+
</li>
262+
</ul>
263+
</li>
264+
</ul>
265+
</li>
266+
</ul>
267+
</div>
268+
</div>
269+
<!-- ========= END OF CLASS DATA ========= -->
270+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
271+
<div class="bottomNav"><a name="navbar.bottom">
272+
<!-- -->
273+
</a>
274+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
275+
<a name="navbar.bottom.firstrow">
276+
<!-- -->
277+
</a>
278+
<ul class="navList" title="Navigation">
279+
<li><a href="../../../../overview-summary.html">Overview</a></li>
280+
<li><a href="package-summary.html">Package</a></li>
281+
<li class="navBarCell1Rev">Class</li>
282+
<li><a href="package-tree.html">Tree</a></li>
283+
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
284+
<li><a href="../../../../index-all.html">Index</a></li>
285+
<li><a href="../../../../help-doc.html">Help</a></li>
286+
</ul>
287+
</div>
288+
<div class="subNav">
289+
<ul class="navList">
290+
<li>Prev&nbsp;Class</li>
291+
<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>
292+
</ul>
293+
<ul class="navList">
294+
<li><a href="../../../../index.html?com/pubnub/api/builder/PresenceBuilder.html" target="_top">Frames</a></li>
295+
<li><a href="PresenceBuilder.html" target="_top">No&nbsp;Frames</a></li>
296+
</ul>
297+
<ul class="navList" id="allclasses_navbar_bottom">
298+
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
299+
</ul>
300+
<div>
301+
<script type="text/javascript"><!--
302+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
303+
if(window==top) {
304+
allClassesLink.style.display = "block";
305+
}
306+
else {
307+
allClassesLink.style.display = "none";
308+
}
309+
//-->
310+
</script>
311+
</div>
312+
<div>
313+
<ul class="subNavList">
314+
<li>Summary:&nbsp;</li>
315+
<li>Nested&nbsp;|&nbsp;</li>
316+
<li>Field&nbsp;|&nbsp;</li>
317+
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
318+
<li><a href="#method.summary">Method</a></li>
319+
</ul>
320+
<ul class="subNavList">
321+
<li>Detail:&nbsp;</li>
322+
<li>Field&nbsp;|&nbsp;</li>
323+
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
324+
<li><a href="#method.detail">Method</a></li>
325+
</ul>
326+
</div>
327+
<a name="skip.navbar.bottom">
328+
<!-- -->
329+
</a></div>
330+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
331+
</body>
332+
</html>

0 commit comments

Comments
 (0)