Skip to content

Commit b15d770

Browse files
committed
Chat api documentation
1 parent 78478a4 commit b15d770

File tree

11 files changed

+3937
-88590
lines changed

11 files changed

+3937
-88590
lines changed

doc/QB.chat.html

Lines changed: 1721 additions & 2 deletions
Large diffs are not rendered by default.

doc/QB.chat.roster.html

Lines changed: 937 additions & 0 deletions
Large diffs are not rendered by default.

doc/QB.html

Lines changed: 115 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ <h3 class="applicationName"><a href="index.html">QuickBlox JavaScript SDK</a></h
4545

4646
<span class="subtitle">Members</span>
4747

48-
<li data-name="QB.version"><a href="QB.html#.version">version</a></li>
48+
<li data-name="QB.this.buildNumber"><a href="QB.html#.this.buildNumber">this.buildNumber</a></li>
49+
50+
<li data-name="QB.this.version"><a href="QB.html#.this.version">this.version</a></li>
4951

5052
</ul>
5153
<ul class="typedefs itemMembers">
@@ -88,6 +90,65 @@ <h3 class="applicationName"><a href="index.html">QuickBlox JavaScript SDK</a></h
8890
</ul>
8991
<ul class="methods itemMembers">
9092

93+
<span class="subtitle">Methods</span>
94+
95+
<li data-name="QB.chat.connect"><a href="QB.chat.html#.connect">connect</a></li>
96+
97+
<li data-name="QB.chat.disconnect"><a href="QB.chat.html#.disconnect">disconnect</a></li>
98+
99+
<li data-name="QB.chat.onMessageErrorListener"><a href="QB.chat.html#.onMessageErrorListener">onMessageErrorListener</a></li>
100+
101+
<li data-name="QB.chat.onMessageListener"><a href="QB.chat.html#.onMessageListener">onMessageListener</a></li>
102+
103+
<li data-name="QB.chat.onMessageTypingListener"><a href="QB.chat.html#.onMessageTypingListener">onMessageTypingListener</a></li>
104+
105+
<li data-name="QB.chat.onSentMessageCallback"><a href="QB.chat.html#.onSentMessageCallback">onSentMessageCallback</a></li>
106+
107+
<li data-name="QB.chat.send"><a href="QB.chat.html#.send">send</a></li>
108+
109+
<li data-name="QB.chat.sendIsStopTypingStatus"><a href="QB.chat.html#.sendIsStopTypingStatus">sendIsStopTypingStatus</a></li>
110+
111+
<li data-name="QB.chat.sendIsTypingStatus"><a href="QB.chat.html#.sendIsTypingStatus">sendIsTypingStatus</a></li>
112+
113+
<li data-name="QB.chat.sendReadStatus"><a href="QB.chat.html#.sendReadStatus">sendReadStatus</a></li>
114+
115+
<li data-name="QB.chat.sendSystemMessage"><a href="QB.chat.html#.sendSystemMessage">sendSystemMessage</a></li>
116+
117+
<li data-name="QB.chat#onDeliveredStatusListener"><a href="QB.chat.html#onDeliveredStatusListener">onDeliveredStatusListener</a></li>
118+
119+
</ul>
120+
<ul class="events itemMembers">
121+
122+
</ul>
123+
</li>
124+
125+
<li class="item" data-name="QB.chat.roster">
126+
<span class="title">
127+
<a href="QB.chat.roster.html">QB.chat.roster</a>
128+
129+
<span class="static">static</span>
130+
131+
</span>
132+
<ul class="members itemMembers">
133+
134+
</ul>
135+
<ul class="typedefs itemMembers">
136+
137+
</ul>
138+
<ul class="methods itemMembers">
139+
140+
<span class="subtitle">Methods</span>
141+
142+
<li data-name="QB.chat.roster.add"><a href="QB.chat.roster.html#.add">add</a></li>
143+
144+
<li data-name="QB.chat.roster.confirm"><a href="QB.chat.roster.html#.confirm">confirm</a></li>
145+
146+
<li data-name="QB.chat.roster.get"><a href="QB.chat.roster.html#.get">get</a></li>
147+
148+
<li data-name="QB.chat.roster.reject"><a href="QB.chat.roster.html#.reject">reject</a></li>
149+
150+
<li data-name="QB.chat.roster.remove"><a href="QB.chat.roster.html#.remove">remove</a></li>
151+
91152
</ul>
92153
<ul class="events itemMembers">
93154

@@ -172,7 +233,52 @@ <h3 class="subsection-title">Members</h3>
172233

173234
<dt>
174235
<div class="nameContainer">
175-
<h4 class="name" id=".version"><span class="type-signature static">static</span>QB.version</h4>
236+
<h4 class="name" id=".this.buildNumber"><span class="type-signature static">static</span>QB.this.buildNumber</h4>
237+
</div>
238+
239+
240+
</dt>
241+
<dd>
242+
243+
<div class="description">
244+
Return current build number of QuickBlox JavaScript SDK
245+
</div>
246+
247+
248+
249+
<dl class="details">
250+
251+
252+
253+
254+
255+
256+
257+
258+
259+
260+
261+
262+
263+
264+
265+
266+
267+
268+
269+
270+
271+
</dl>
272+
273+
274+
275+
</dd>
276+
277+
278+
279+
<dt>
280+
<div class="nameContainer">
281+
<h4 class="name" id=".this.version"><span class="type-signature static">static</span>QB.this.version</h4>
176282
</div>
177283

178284

@@ -230,7 +336,7 @@ <h4 class="name" id=".createSession">
230336

231337

232338
<div class="tag-source">
233-
qbMain.js, line 111
339+
qbMain.js, line 118
234340
</div>
235341

236342
</div>
@@ -369,7 +475,7 @@ <h4 class="name" id=".destroySession">
369475

370476

371477
<div class="tag-source">
372-
qbMain.js, line 126
478+
qbMain.js, line 133
373479
</div>
374480

375481
</div>
@@ -485,7 +591,7 @@ <h4 class="name" id=".getSession">
485591

486592

487593
<div class="tag-source">
488-
qbMain.js, line 95
594+
qbMain.js, line 102
489595
</div>
490596

491597
</div>
@@ -601,7 +707,7 @@ <h4 class="name" id=".init">
601707

602708

603709
<div class="tag-source">
604-
qbMain.js, line 32
710+
qbMain.js, line 27
605711
</div>
606712

607713
</div>
@@ -788,7 +894,7 @@ <h4 class="name" id=".login">
788894

789895

790896
<div class="tag-source">
791-
qbMain.js, line 142
897+
qbMain.js, line 149
792898
</div>
793899

794900
</div>
@@ -927,7 +1033,7 @@ <h4 class="name" id=".logout">
9271033

9281034

9291035
<div class="tag-source">
930-
qbMain.js, line 157
1036+
qbMain.js, line 164
9311037
</div>
9321038

9331039
</div>
@@ -1049,7 +1155,7 @@ <h4 class="name" id=".logout">
10491155

10501156

10511157
<footer>
1052-
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Nov 11 2016 18:58:30 GMT+0200 (EET)
1158+
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 23 2016 19:30:50 GMT+0200 (EET)
10531159
</footer>
10541160
</div>
10551161
</div>

0 commit comments

Comments
 (0)