Skip to content

Commit 42b28b8

Browse files
jcbrandjcbrand
committed
Update docs to provide examples of server-side prebind code. Updates conversejs#116 
1 parent cd144a9 commit 42b28b8

File tree

9 files changed

+182
-105
lines changed

9 files changed

+182
-105
lines changed

‎docs/doctrees/index.doctree

5.03 KB
Binary file not shown.

‎docs/html/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 652c197d955de4d2c90bb99dc6534a15
3+
config: 9cade5fa70d219453c215cec2a2631df
44
tags: fbb0d17656682115ca4d033fb2f83ba1

‎docs/html/_sources/index.txt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,17 @@ These values are then passed to converse.js's ``initialize`` method.
277277
**bosh_service_url** values.
278278

279279

280+
Example code for server-side prebinding
281+
---------------------------------------
282+
283+
* PHP:
284+
See `xmpp-prebind-php <https://github.com/candy-chat/xmpp-prebind-php>`_ by
285+
Michael Weibel and the folks from Candy chat.
286+
287+
* Python:
288+
See this `example Django application`_ by Jack Moffitt.
289+
290+
280291
Setting up a BOSH server
281292
------------------------
282293

@@ -387,6 +398,7 @@ If you don't have grunt installed globally, you need to specify the relative
387398
path:
388399

389400
::
401+
390402
./node_modules/.bin/grunt fetch
391403

392404
This will call Bower in the background to fetch all the front-end
@@ -813,6 +825,28 @@ the page with class *toggle-online-users*.
813825
If this options is set to true, the controlbox will by default be shown upon
814826
page load.
815827

828+
829+
show_call_button
830+
----------------
831+
832+
Default = ``false``
833+
834+
Enable to display a call button on the chatbox toolbar.
835+
836+
When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.
837+
838+
::
839+
840+
converse.on('onCallButtonClicked', function(event, data) {
841+
console.log('Call button was clicked.');
842+
console.log('Strophe connection is', data.connection);
843+
console.log('Bare buddy JID is', data.model.get('jid'));
844+
845+
// ... Third-party library code ...
846+
});
847+
848+
849+
816850
show_only_online_users
817851
----------------------
818852

‎docs/html/genindex.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
<head>
1010
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1111

12-
<title>Index &mdash; Converse.js 0.7.1 documentation</title>
12+
<title>Index &mdash; Converse.js 0.7.2 documentation</title>
1313

1414
<link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
1515
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1616

1717
<script type="text/javascript">
1818
var DOCUMENTATION_OPTIONS = {
1919
URL_ROOT: '',
20-
VERSION: '0.7.1',
20+
VERSION: '0.7.2',
2121
COLLAPSE_INDEX: false,
2222
FILE_SUFFIX: '.html',
2323
HAS_SOURCE: true
@@ -26,7 +26,7 @@
2626
<script type="text/javascript" src="_static/jquery.js"></script>
2727
<script type="text/javascript" src="_static/underscore.js"></script>
2828
<script type="text/javascript" src="_static/doctools.js"></script>
29-
<link rel="top" title="Converse.js 0.7.1 documentation" href="index.html" />
29+
<link rel="top" title="Converse.js 0.7.2 documentation" href="index.html" />
3030
</head>
3131
<body>
3232
<div id="header_wrap" class="outer">
@@ -51,7 +51,7 @@ <h3>Navigation</h3>
5151
<li class="right" style="margin-right: 10px">
5252
<a href="#" title="General Index"
5353
accesskey="I">index</a></li>
54-
<li><a href="index.html">Converse.js 0.7.1 documentation</a> &raquo;</li>
54+
<li><a href="index.html">Converse.js 0.7.2 documentation</a> &raquo;</li>
5555
</ul>
5656
</div>
5757
<section id="main_content" class="inner">
@@ -80,7 +80,7 @@ <h3>Navigation</h3>
8080
<li class="right" style="margin-right: 10px">
8181
<a href="#" title="General Index"
8282
>index</a></li>
83-
<li><a href="index.html">Converse.js 0.7.1 documentation</a> &raquo;</li>
83+
<li><a href="index.html">Converse.js 0.7.2 documentation</a> &raquo;</li>
8484
</ul>
8585
</div>
8686
</div>

‎docs/html/index.html

Lines changed: 124 additions & 92 deletions
Large diffs are not rendered by default.

‎docs/html/objects.inv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Sphinx inventory version 2
22
# Project: Converse.js
3-
# Version: 0.7.1
3+
# Version: 0.7.2
44
# The remainder of this file is compressed using zlib.
55
x�m��
66
� �{�"���]�;

‎docs/html/search.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
<head>
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
99

10-
<title>Search &mdash; Converse.js 0.7.1 documentation</title>
10+
<title>Search &mdash; Converse.js 0.7.2 documentation</title>
1111

1212
<link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
1313
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1414

1515
<script type="text/javascript">
1616
var DOCUMENTATION_OPTIONS = {
1717
URL_ROOT: '',
18-
VERSION: '0.7.1',
18+
VERSION: '0.7.2',
1919
COLLAPSE_INDEX: false,
2020
FILE_SUFFIX: '.html',
2121
HAS_SOURCE: true
@@ -25,7 +25,7 @@
2525
<script type="text/javascript" src="_static/underscore.js"></script>
2626
<script type="text/javascript" src="_static/doctools.js"></script>
2727
<script type="text/javascript" src="_static/searchtools.js"></script>
28-
<link rel="top" title="Converse.js 0.7.1 documentation" href="index.html" />
28+
<link rel="top" title="Converse.js 0.7.2 documentation" href="index.html" />
2929
<script type="text/javascript">
3030
jQuery(function() { Search.loadIndex("searchindex.js"); });
3131
</script>
@@ -55,7 +55,7 @@ <h3>Navigation</h3>
5555
<li class="right" style="margin-right: 10px">
5656
<a href="genindex.html" title="General Index"
5757
accesskey="I">index</a></li>
58-
<li><a href="index.html">Converse.js 0.7.1 documentation</a> &raquo;</li>
58+
<li><a href="index.html">Converse.js 0.7.2 documentation</a> &raquo;</li>
5959
</ul>
6060
</div>
6161
<section id="main_content" class="inner">
@@ -100,7 +100,7 @@ <h3>Navigation</h3>
100100
<li class="right" style="margin-right: 10px">
101101
<a href="genindex.html" title="General Index"
102102
>index</a></li>
103-
<li><a href="index.html">Converse.js 0.7.1 documentation</a> &raquo;</li>
103+
<li><a href="index.html">Converse.js 0.7.2 documentation</a> &raquo;</li>
104104
</ul>
105105
</div>
106106
</div>

‎docs/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/source/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,17 @@ These values are then passed to converse.js's ``initialize`` method.
277277
**bosh_service_url** values.
278278

279279

280+
Example code for server-side prebinding
281+
---------------------------------------
282+
283+
* PHP:
284+
See `xmpp-prebind-php <https://github.com/candy-chat/xmpp-prebind-php>`_ by
285+
Michael Weibel and the folks from Candy chat.
286+
287+
* Python:
288+
See this `example Django application`_ by Jack Moffitt.
289+
290+
280291
Setting up a BOSH server
281292
------------------------
282293

0 commit comments

Comments
 (0)