Skip to content

Commit 0211f1a

Browse files
committed
JSDoc Chat module
1 parent b15d770 commit 0211f1a

File tree

12 files changed

+552
-378
lines changed

12 files changed

+552
-378
lines changed

doc/QB.chat.html

Lines changed: 327 additions & 163 deletions
Large diffs are not rendered by default.

doc/QB.chat.roster.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,16 @@ <h3 class="applicationName"><a href="index.html">QuickBlox JavaScript SDK</a></h
9696

9797
<li data-name="QB.chat.disconnect"><a href="QB.chat.html#.disconnect">disconnect</a></li>
9898

99+
<li data-name="QB.chat.onDeliveredStatusListener"><a href="QB.chat.html#.onDeliveredStatusListener">onDeliveredStatusListener</a></li>
100+
99101
<li data-name="QB.chat.onMessageErrorListener"><a href="QB.chat.html#.onMessageErrorListener">onMessageErrorListener</a></li>
100102

101103
<li data-name="QB.chat.onMessageListener"><a href="QB.chat.html#.onMessageListener">onMessageListener</a></li>
102104

103105
<li data-name="QB.chat.onMessageTypingListener"><a href="QB.chat.html#.onMessageTypingListener">onMessageTypingListener</a></li>
104106

107+
<li data-name="QB.chat.onReadStatusListener"><a href="QB.chat.html#.onReadStatusListener">onReadStatusListener</a></li>
108+
105109
<li data-name="QB.chat.onSentMessageCallback"><a href="QB.chat.html#.onSentMessageCallback">onSentMessageCallback</a></li>
106110

107111
<li data-name="QB.chat.send"><a href="QB.chat.html#.send">send</a></li>
@@ -114,8 +118,6 @@ <h3 class="applicationName"><a href="index.html">QuickBlox JavaScript SDK</a></h
114118

115119
<li data-name="QB.chat.sendSystemMessage"><a href="QB.chat.html#.sendSystemMessage">sendSystemMessage</a></li>
116120

117-
<li data-name="QB.chat#onDeliveredStatusListener"><a href="QB.chat.html#onDeliveredStatusListener">onDeliveredStatusListener</a></li>
118-
119121
</ul>
120122
<ul class="events itemMembers">
121123

@@ -532,7 +534,7 @@ <h4 class="name" id=".get">
532534

533535

534536
<div class="description">
535-
Get contact list. <a target="_blank" href="https://quickblox.com/developers/Web_XMPP_Chat_Sample#Contact_List">More info.</a>
537+
Receive contact list. <a target="_blank" href="https://quickblox.com/developers/Web_XMPP_Chat_Sample#Contact_List">More info.</a>
536538
</div>
537539

538540

@@ -711,7 +713,7 @@ <h4 class="name" id=".reject">
711713
<td class="type">
712714

713715

714-
<span class="param-type">rejectRosterCallback</span>
716+
<span class="param-type"><a href="global.html#rejectRosterCallback">rejectRosterCallback</a></span>
715717

716718

717719

@@ -927,7 +929,7 @@ <h4 class="name" id=".remove">
927929

928930

929931
<footer>
930-
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)
932+
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 23 2016 23:42:51 GMT+0200 (EET)
931933
</footer>
932934
</div>
933935
</div>

doc/QB.html

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,16 @@ <h3 class="applicationName"><a href="index.html">QuickBlox JavaScript SDK</a></h
9696

9797
<li data-name="QB.chat.disconnect"><a href="QB.chat.html#.disconnect">disconnect</a></li>
9898

99+
<li data-name="QB.chat.onDeliveredStatusListener"><a href="QB.chat.html#.onDeliveredStatusListener">onDeliveredStatusListener</a></li>
100+
99101
<li data-name="QB.chat.onMessageErrorListener"><a href="QB.chat.html#.onMessageErrorListener">onMessageErrorListener</a></li>
100102

101103
<li data-name="QB.chat.onMessageListener"><a href="QB.chat.html#.onMessageListener">onMessageListener</a></li>
102104

103105
<li data-name="QB.chat.onMessageTypingListener"><a href="QB.chat.html#.onMessageTypingListener">onMessageTypingListener</a></li>
104106

107+
<li data-name="QB.chat.onReadStatusListener"><a href="QB.chat.html#.onReadStatusListener">onReadStatusListener</a></li>
108+
105109
<li data-name="QB.chat.onSentMessageCallback"><a href="QB.chat.html#.onSentMessageCallback">onSentMessageCallback</a></li>
106110

107111
<li data-name="QB.chat.send"><a href="QB.chat.html#.send">send</a></li>
@@ -114,8 +118,6 @@ <h3 class="applicationName"><a href="index.html">QuickBlox JavaScript SDK</a></h
114118

115119
<li data-name="QB.chat.sendSystemMessage"><a href="QB.chat.html#.sendSystemMessage">sendSystemMessage</a></li>
116120

117-
<li data-name="QB.chat#onDeliveredStatusListener"><a href="QB.chat.html#onDeliveredStatusListener">onDeliveredStatusListener</a></li>
118-
119121
</ul>
120122
<ul class="events itemMembers">
121123

@@ -347,7 +349,7 @@ <h4 class="name" id=".createSession">
347349

348350

349351
<div class="description">
350-
Will create new session. <a target="_blank" href="https://quickblox.com/developers/Javascript#Authorization">More info</a>
352+
Creat new session. <a target="_blank" href="https://quickblox.com/developers/Javascript#Authorization">More info</a>
351353
</div>
352354

353355

@@ -407,7 +409,7 @@ <h4 class="name" id=".createSession">
407409
<td class="type">
408410

409411

410-
<span class="param-type"><a href="global.html#destroySessionCallback">destroySessionCallback</a></span>
412+
<span class="param-type">createSessionCallback</span>
411413

412414

413415

@@ -486,7 +488,7 @@ <h4 class="name" id=".destroySession">
486488

487489

488490
<div class="description">
489-
Will destroy current session. <a target="_blank" href="https://quickblox.com/developers/Authentication_and_Authorization#API_Session_Destroy">More info</a>
491+
Destroy current session. <a target="_blank" href="https://quickblox.com/developers/Authentication_and_Authorization#API_Session_Destroy">More info</a>
490492
</div>
491493

492494

@@ -533,7 +535,7 @@ <h4 class="name" id=".destroySession">
533535

534536
<td class="description last">
535537

536-
The destroySessionCallback callback.</td>
538+
The destroySessionCallback function.</td>
537539
</tr>
538540

539541

@@ -602,7 +604,7 @@ <h4 class="name" id=".getSession">
602604

603605

604606
<div class="description">
605-
Will return current session
607+
Return current session
606608
</div>
607609

608610

@@ -649,7 +651,7 @@ <h4 class="name" id=".getSession">
649651

650652
<td class="description last">
651653

652-
The getSessionCallback callback.</td>
654+
The getSessionCallback function.</td>
653655
</tr>
654656

655657

@@ -790,7 +792,7 @@ <h4 class="name" id=".init">
790792

791793
<td class="description last">
792794

793-
Authorization key or Application ID. You need to set Application ID if you use sessionToken as appIdOrToken parameter.</td>
795+
Authorization key or Application ID. You need to set up Application ID if you use session token as appIdOrToken parameter.</td>
794796
</tr>
795797

796798

@@ -836,7 +838,7 @@ <h4 class="name" id=".init">
836838

837839
<td class="description last">
838840

839-
An Object of settings for QuickBlox SDK.</td>
841+
Settings object for QuickBlox SDK.</td>
840842
</tr>
841843

842844

@@ -952,7 +954,7 @@ <h4 class="name" id=".login">
952954

953955
<td class="description last">
954956

955-
Object login of params.</td>
957+
Params object for login into the session.</td>
956958
</tr>
957959

958960

@@ -975,7 +977,7 @@ <h4 class="name" id=".login">
975977

976978
<td class="description last">
977979

978-
.</td>
980+
The loginCallback function.</td>
979981
</tr>
980982

981983

@@ -1091,7 +1093,7 @@ <h4 class="name" id=".logout">
10911093

10921094
<td class="description last">
10931095

1094-
Should be applecationID or QBtoken.</td>
1096+
The logoutCallback function.</td>
10951097
</tr>
10961098

10971099

@@ -1155,7 +1157,7 @@ <h4 class="name" id=".logout">
11551157

11561158

11571159
<footer>
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)
1160+
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 23 2016 23:42:51 GMT+0200 (EET)
11591161
</footer>
11601162
</div>
11611163
</div>

0 commit comments

Comments
 (0)