Skip to content

C
converse.js
Commit 517e6001 authored by JC Brand's avatar JC Brand
Browse files
Options

Expand documentation on the new visible_toolbar_buttons config option

parent 9b360131
Hide whitespace changes
Inline Side-by-side
Showing with 302 additions and 237 deletions
docs/html/_sources/index.txt
View file @ 517e6001
......@@ -826,7 +826,7 @@ Configuration variables
allow_contact_requests
----------------------
Default = ``true``
Default: ``true``
Allow users to add one another as contacts. If this is set to false, the
**Add a contact** widget, **Contact Requests** and **Pending Contacts** roster
......@@ -836,22 +836,29 @@ ignored.
allow_muc
---------
Default = ``true``
Default: ``true``
Allow multi-user chat (muc) in chatrooms. Setting this to ``false`` will remove
the ``Chatrooms`` tab from the control box.
allow_muc
---------
Default: ``true``
Allow Off-the-record encryption of single-user chat messages.
animate
-------
Default = ``true``
Default: ``true``
Show animations, for example when opening and closing chat boxes.
auto_list_rooms
---------------
Default = ``false``
Default: ``false``
If true, and the XMPP server on which the current user is logged in supports
multi-user chat, then a list of rooms on that server will be fetched.
......@@ -865,7 +872,7 @@ option will create lots of extra connection traffic.
auto_reconnect
--------------
Default = ``true``
Default: ``true``
Automatically reconnect to the XMPP server if the connection drops
unexpectedly.
......@@ -873,7 +880,7 @@ unexpectedly.
auto_subscribe
--------------
Default = ``false``
Default: ``false``
If true, the user will automatically subscribe back to any contact requests.
......@@ -888,7 +895,7 @@ See `here <http://metajack.im/2008/09/08/which-bosh-server-do-you-need>`_ for mo
cache_otr_key
-------------
Default = ``false``
Default: ``false``
Let the `OTR (Off-the-record encryption) <https://otr.cypherpunks.ca>`_ private
key be cached in your browser's session storage.
......@@ -912,21 +919,21 @@ This setting can only be used together with ``allow_otr = true``.
debug
-----
Default = ``false``
Default: ``false``
If set to true, debugging output will be logged to the browser console.
enable_message_carbons
----------------------
Default = ``false``
Default: ``false``
Support for `XEP-0280: Message Carbons <https://xmpp.org/extensions/xep-0280.html>`_
expose_rid_and_sid
------------------
Default = ``false``
Default: ``false``
Allow the prebind tokens, RID (request ID) and SID (session ID), to be exposed
globally via the API. This allows other scripts served on the same page to use
......@@ -938,7 +945,7 @@ and inject fake chat messages.
forward_messages
----------------
Default = ``false``
Default: ``false``
If set to ``true``, sent messages will also be forwarded to other connected
XMPP resources (e.g. chat clients) of the same user.
......@@ -957,7 +964,7 @@ logged in user, otherwise the user's vCard will be fetched.
hide_muc_server
---------------
Default = ``false``
Default: ``false``
Hide the ``server`` input field of the form inside the ``Room`` panel of the
controlbox. Useful if you want to restrict users to a specific XMPP server of
......@@ -972,7 +979,7 @@ Specify the locale/language. The language must be in the ``locales`` object. Ref
prebind
--------
Default = ``false``
Default: ``false``
Use this option when you want to attach to an existing XMPP connection that was
already authenticated (usually on the backend before page load).
......@@ -992,7 +999,7 @@ Additionally, you have to specify ``bosh_service_url``.
show_controlbox_by_default
--------------------------
Default = ``false``
Default: ``false``
The "controlbox" refers to the special chatbox containing your contacts roster,
status widget, chatrooms and other controls.
......@@ -1003,32 +1010,10 @@ the page with class *toggle-online-users*.
If this options is set to true, the controlbox will by default be shown upon
page load.
show_call_button
----------------
Default = ``false``
Enable to display a call button on the chatbox toolbar.
When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.
::
converse.on('onCallButtonClicked', function(event, data) {
console.log('Call button was clicked.');
console.log('Strophe connection is', data.connection);
console.log('Bare buddy JID is', data.model.get('jid'));
// ... Third-party library code ...
});
show_only_online_users
----------------------
Default = ``false``
Default: ``false``
If set to ``true``, only online users will be shown in the contacts roster.
Users with any other status (e.g. away, busy etc.) will not be shown.
......@@ -1036,7 +1021,7 @@ Users with any other status (e.g. away, busy etc.) will not be shown.
use_otr_by_default
------------------
Default = ``false``
Default: ``false``
If set to ``true``, Converse.js will automatically try to initiate an OTR (off-the-record)
encrypted chat session every time you open a chat box.
......@@ -1044,16 +1029,48 @@ encrypted chat session every time you open a chat box.
use_vcards
----------
Default = ``true``
Default: ``true``
Determines whether the XMPP server will be queried for roster contacts' VCards
or not. VCards contain extra personal information such as your fullname and
avatar image.
visible_toolbar_buttons
-----------------------
Default:
::
{
'emoticons': true,
'call': false,
'clear': true
}
Allows you to show or hide buttons on the chat boxes' toolbars.
* *emoticons*:
Enables rendering of emoticons and provides a toolbar button for choosing them.
* *call*:
Provides a button with a picture of a telephone on it.
When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.
::
converse.on('onCallButtonClicked', function(event, data) {
console.log('Strophe connection is', data.connection);
console.log('Bare buddy JID is', data.model.get('jid'));
// ... Third-party library code ...
});
* *clear*:
Provides a button for clearing messages from a chat box.
xhr_custom_status
-----------------
Default = ``false``
Default: ``false``
.. Note ::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
......@@ -1067,7 +1084,7 @@ xhr_custom_status_url
.. Note ::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Default = Empty string
Default: Empty string
Used only in conjunction with ``xhr_custom_status``.
......@@ -1079,7 +1096,7 @@ The message itself is sent in the request under the key ``msg``.
xhr_user_search
---------------
Default = ``false``
Default: ``false``
.. Note ::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
......@@ -1102,7 +1119,7 @@ xhr_user_search_url
.. Note ::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Default = Empty string
Default: Empty string
Used only in conjunction with ``xhr_user_search``.
......
docs/html/index.html
View file @ 517e6001
......@@ -65,84 +65,85 @@
<div class="contents local topic" id="table-of-contents">
<p class="topic-title first">Table of Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#quickstart-to-get-a-demo-up-and-running" id="id3">Quickstart (to get a demo up and running)</a></li>
<li><a class="reference internal" href="#introduction" id="id4">Introduction</a></li>
<li><a class="reference internal" href="#what-you-will-need" id="id5">What you will need</a><ul>
<li><a class="reference internal" href="#an-xmpp-jabber-server" id="id6">An XMPP/Jabber server</a></li>
<li><a class="reference internal" href="#connection-manager" id="id7">Connection Manager</a><ul>
<li><a class="reference internal" href="#overcoming-cross-domain-request-restrictions" id="id8">Overcoming cross-domain request restrictions</a></li>
<li><a class="reference internal" href="#quickstart-to-get-a-demo-up-and-running" id="id4">Quickstart (to get a demo up and running)</a></li>
<li><a class="reference internal" href="#introduction" id="id5">Introduction</a></li>
<li><a class="reference internal" href="#what-you-will-need" id="id6">What you will need</a><ul>
<li><a class="reference internal" href="#an-xmpp-jabber-server" id="id7">An XMPP/Jabber server</a></li>
<li><a class="reference internal" href="#connection-manager" id="id8">Connection Manager</a><ul>
<li><a class="reference internal" href="#overcoming-cross-domain-request-restrictions" id="id9">Overcoming cross-domain request restrictions</a></li>
</ul>
</li>
<li><a class="reference internal" href="#server-side-authentication" id="id9">Server-side authentication</a><ul>
<li><a class="reference internal" href="#prebinding-and-single-session-support" id="id10">Prebinding and Single Session Support</a></li>
<li><a class="reference internal" href="#example-code-for-server-side-prebinding" id="id11">Example code for server-side prebinding</a></li>
<li><a class="reference internal" href="#setting-up-a-bosh-server" id="id12">Setting up a BOSH server</a></li>
<li><a class="reference internal" href="#server-side-authentication" id="id10">Server-side authentication</a><ul>
<li><a class="reference internal" href="#prebinding-and-single-session-support" id="id11">Prebinding and Single Session Support</a></li>
<li><a class="reference internal" href="#example-code-for-server-side-prebinding" id="id12">Example code for server-side prebinding</a></li>
<li><a class="reference internal" href="#setting-up-a-bosh-server" id="id13">Setting up a BOSH server</a></li>
</ul>
</li>
<li><a class="reference internal" href="#facebook-integration" id="id13">Facebook integration</a></li>
<li><a class="reference internal" href="#facebook-integration" id="id14">Facebook integration</a></li>
</ul>
</li>
<li><a class="reference internal" href="#features" id="id14">Features</a><ul>
<li><a class="reference internal" href="#off-the-record-encryption" id="id15">Off-the-record encryption</a></li>
<li><a class="reference internal" href="#features" id="id15">Features</a><ul>
<li><a class="reference internal" href="#off-the-record-encryption" id="id16">Off-the-record encryption</a></li>
</ul>
</li>
<li><a class="reference internal" href="#development" id="id16">Development</a><ul>
<li><a class="reference internal" href="#install-the-development-and-front-end-dependencies" id="id17">Install the development and front-end dependencies</a></li>
<li><a class="reference internal" href="#with-amd-and-require-js-recommended" id="id18">With AMD and require.js (recommended)</a></li>
<li><a class="reference internal" href="#without-amd-and-require-js" id="id19">Without AMD and require.js</a></li>
<li><a class="reference internal" href="#before-submitting-a-pull-request" id="id20">Before submitting a pull request</a><ul>
<li><a class="reference internal" href="#add-tests-for-your-bugfix-or-feature" id="id21">Add tests for your bugfix or feature</a></li>
<li><a class="reference internal" href="#check-that-the-tests-pass" id="id22">Check that the tests pass</a></li>
<li><a class="reference internal" href="#check-your-code-for-errors-or-bad-habits-by-running-jshint" id="id23">Check your code for errors or bad habits by running JSHint</a></li>
<li><a class="reference internal" href="#development" id="id17">Development</a><ul>
<li><a class="reference internal" href="#install-the-development-and-front-end-dependencies" id="id18">Install the development and front-end dependencies</a></li>
<li><a class="reference internal" href="#with-amd-and-require-js-recommended" id="id19">With AMD and require.js (recommended)</a></li>
<li><a class="reference internal" href="#without-amd-and-require-js" id="id20">Without AMD and require.js</a></li>
<li><a class="reference internal" href="#before-submitting-a-pull-request" id="id21">Before submitting a pull request</a><ul>
<li><a class="reference internal" href="#add-tests-for-your-bugfix-or-feature" id="id22">Add tests for your bugfix or feature</a></li>
<li><a class="reference internal" href="#check-that-the-tests-pass" id="id23">Check that the tests pass</a></li>
<li><a class="reference internal" href="#check-your-code-for-errors-or-bad-habits-by-running-jshint" id="id24">Check your code for errors or bad habits by running JSHint</a></li>
</ul>
</li>
<li><a class="reference internal" href="#minification" id="id24">Minification</a><ul>
<li><a class="reference internal" href="#minifying-javascript-and-css" id="id25">Minifying Javascript and CSS</a></li>
<li><a class="reference internal" href="#minification" id="id25">Minification</a><ul>
<li><a class="reference internal" href="#minifying-javascript-and-css" id="id26">Minifying Javascript and CSS</a></li>
</ul>
</li>
<li><a class="reference internal" href="#translations" id="id26">Translations</a></li>
<li><a class="reference internal" href="#translations" id="id27">Translations</a></li>
</ul>
</li>
<li><a class="reference internal" href="#troubleshooting" id="id27">Troubleshooting</a><ul>
<li><a class="reference internal" href="#conflicts-with-other-javascript-libraries" id="id28">Conflicts with other Javascript libraries</a><ul>
<li><a class="reference internal" href="#problem" id="id29">Problem:</a></li>
<li><a class="reference internal" href="#solution" id="id30">Solution:</a></li>
<li><a class="reference internal" href="#troubleshooting" id="id28">Troubleshooting</a><ul>
<li><a class="reference internal" href="#conflicts-with-other-javascript-libraries" id="id29">Conflicts with other Javascript libraries</a><ul>
<li><a class="reference internal" href="#problem" id="id30">Problem:</a></li>
<li><a class="reference internal" href="#solution" id="id31">Solution:</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#events" id="id31">Events</a><ul>
<li><a class="reference internal" href="#event-methods" id="id32">Event Methods</a></li>
<li><a class="reference internal" href="#event-types" id="id33">Event Types</a></li>
<li><a class="reference internal" href="#events" id="id32">Events</a><ul>
<li><a class="reference internal" href="#event-methods" id="id33">Event Methods</a></li>
<li><a class="reference internal" href="#event-types" id="id34">Event Types</a></li>
</ul>
</li>
<li><a class="reference internal" href="#configuration" id="id34">Configuration</a><ul>
<li><a class="reference internal" href="#configuration-variables" id="id35">Configuration variables</a><ul>
<li><a class="reference internal" href="#allow-contact-requests" id="id36">allow_contact_requests</a></li>
<li><a class="reference internal" href="#allow-muc" id="id37">allow_muc</a></li>
<li><a class="reference internal" href="#animate" id="id38">animate</a></li>
<li><a class="reference internal" href="#auto-list-rooms" id="id39">auto_list_rooms</a></li>
<li><a class="reference internal" href="#auto-reconnect" id="id40">auto_reconnect</a></li>
<li><a class="reference internal" href="#auto-subscribe" id="id41">auto_subscribe</a></li>
<li><a class="reference internal" href="#bosh-service-url" id="id42">bosh_service_url</a></li>
<li><a class="reference internal" href="#cache-otr-key" id="id43">cache_otr_key</a></li>
<li><a class="reference internal" href="#debug" id="id44">debug</a></li>
<li><a class="reference internal" href="#enable-message-carbons" id="id45">enable_message_carbons</a></li>
<li><a class="reference internal" href="#expose-rid-and-sid" id="id46">expose_rid_and_sid</a></li>
<li><a class="reference internal" href="#forward-messages" id="id47">forward_messages</a></li>
<li><a class="reference internal" href="#fullname" id="id48">fullname</a></li>
<li><a class="reference internal" href="#hide-muc-server" id="id49">hide_muc_server</a></li>
<li><a class="reference internal" href="#i18n" id="id50">i18n</a></li>
<li><a class="reference internal" href="#prebind" id="id51">prebind</a></li>
<li><a class="reference internal" href="#show-controlbox-by-default" id="id52">show_controlbox_by_default</a></li>
<li><a class="reference internal" href="#show-call-button" id="id53">show_call_button</a></li>
<li><a class="reference internal" href="#show-only-online-users" id="id54">show_only_online_users</a></li>
<li><a class="reference internal" href="#use-otr-by-default" id="id55">use_otr_by_default</a></li>
<li><a class="reference internal" href="#use-vcards" id="id56">use_vcards</a></li>
<li><a class="reference internal" href="#xhr-custom-status" id="id57">xhr_custom_status</a></li>
<li><a class="reference internal" href="#xhr-custom-status-url" id="id58">xhr_custom_status_url</a></li>
<li><a class="reference internal" href="#xhr-user-search" id="id59">xhr_user_search</a></li>
<li><a class="reference internal" href="#xhr-user-search-url" id="id60">xhr_user_search_url</a></li>
<li><a class="reference internal" href="#configuration" id="id35">Configuration</a><ul>
<li><a class="reference internal" href="#configuration-variables" id="id36">Configuration variables</a><ul>
<li><a class="reference internal" href="#allow-contact-requests" id="id37">allow_contact_requests</a></li>
<li><a class="reference internal" href="#allow-muc" id="id38">allow_muc</a></li>
<li><a class="reference internal" href="#id2" id="id39">allow_muc</a></li>
<li><a class="reference internal" href="#animate" id="id40">animate</a></li>
<li><a class="reference internal" href="#auto-list-rooms" id="id41">auto_list_rooms</a></li>
<li><a class="reference internal" href="#auto-reconnect" id="id42">auto_reconnect</a></li>
<li><a class="reference internal" href="#auto-subscribe" id="id43">auto_subscribe</a></li>
<li><a class="reference internal" href="#bosh-service-url" id="id44">bosh_service_url</a></li>
<li><a class="reference internal" href="#cache-otr-key" id="id45">cache_otr_key</a></li>
<li><a class="reference internal" href="#debug" id="id46">debug</a></li>
<li><a class="reference internal" href="#enable-message-carbons" id="id47">enable_message_carbons</a></li>
<li><a class="reference internal" href="#expose-rid-and-sid" id="id48">expose_rid_and_sid</a></li>
<li><a class="reference internal" href="#forward-messages" id="id49">forward_messages</a></li>
<li><a class="reference internal" href="#fullname" id="id50">fullname</a></li>
<li><a class="reference internal" href="#hide-muc-server" id="id51">hide_muc_server</a></li>
<li><a class="reference internal" href="#i18n" id="id52">i18n</a></li>
<li><a class="reference internal" href="#prebind" id="id53">prebind</a></li>
<li><a class="reference internal" href="#show-controlbox-by-default" id="id54">show_controlbox_by_default</a></li>
<li><a class="reference internal" href="#show-only-online-users" id="id55">show_only_online_users</a></li>
<li><a class="reference internal" href="#use-otr-by-default" id="id56">use_otr_by_default</a></li>
<li><a class="reference internal" href="#use-vcards" id="id57">use_vcards</a></li>
<li><a class="reference internal" href="#visible-toolbar-buttons" id="id58">visible_toolbar_buttons</a></li>
<li><a class="reference internal" href="#xhr-custom-status" id="id59">xhr_custom_status</a></li>
<li><a class="reference internal" href="#xhr-custom-status-url" id="id60">xhr_custom_status_url</a></li>
<li><a class="reference internal" href="#xhr-user-search" id="id61">xhr_user_search</a></li>
<li><a class="reference internal" href="#xhr-user-search-url" id="id62">xhr_user_search_url</a></li>
</ul>
</li>
</ul>
......@@ -150,7 +151,7 @@
</ul>
</div>
<div class="section" id="quickstart-to-get-a-demo-up-and-running">
<h1><a class="toc-backref" href="#id3">Quickstart (to get a demo up and running)</a><a class="headerlink" href="#quickstart-to-get-a-demo-up-and-running" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id4">Quickstart (to get a demo up and running)</a><a class="headerlink" href="#quickstart-to-get-a-demo-up-and-running" title="Permalink to this headline"></a></h1>
<p>When you download a specific release of <em>Converse.js</em> there will be two minified files inside the zip file.</p>
<ul class="simple">
<li>converse.min.js</li>
......@@ -197,7 +198,7 @@ the minified Javascript file. Read <a class="reference internal" href="#configur
that.</p>
</div>
<div class="section" id="introduction">
<h1><a class="toc-backref" href="#id4">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id5">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h1>
<p>Even though you can connect to public XMPP servers on the <a class="reference external" href="http://conversejs.org">conversejs.org</a>
website, <em>Converse.js</em> is not really meant to be a &#8220;Software-as-a-service&#8221; (SaaS)
webchat.</p>
......@@ -216,9 +217,9 @@ code.</p>
requirements.</p>
</div>
<div class="section" id="what-you-will-need">
<h1><a class="toc-backref" href="#id5">What you will need</a><a class="headerlink" href="#what-you-will-need" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id6">What you will need</a><a class="headerlink" href="#what-you-will-need" title="Permalink to this headline"></a></h1>
<div class="section" id="an-xmpp-jabber-server">
<h2><a class="toc-backref" href="#id6">An XMPP/Jabber server</a><a class="headerlink" href="#an-xmpp-jabber-server" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id7">An XMPP/Jabber server</a><a class="headerlink" href="#an-xmpp-jabber-server" title="Permalink to this headline"></a></h2>
<p><em>Converse.js</em> implements <a class="reference external" href="https://en.wikipedia.org/wiki/Xmpp">XMPP</a> as its messaging protocol, and therefore needs
to connect to an XMPP/Jabber server (Jabber is really just a synonym for XMPP).</p>
<p>You can connect to public XMPP servers like <tt class="docutils literal"><span class="pre">jabber.org</span></tt> but if you want to
......@@ -227,7 +228,7 @@ have <a class="reference internal" href="#session-support">Session Support</a> y
servers that you can set up yourself on <a class="reference external" href="http://xmpp.org/xmpp-software/servers/">xmpp.org</a>.</p>
</div>
<div class="section" id="connection-manager">
<h2><a class="toc-backref" href="#id7">Connection Manager</a><a class="headerlink" href="#connection-manager" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id8">Connection Manager</a><a class="headerlink" href="#connection-manager" title="Permalink to this headline"></a></h2>
<p>Your website and <em>Converse.js</em> use <a class="reference external" href="https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol">HTTP</a> as protocol to communicate with
the webserver. HTTP connections are stateless and usually shortlived.</p>
<p><a class="reference external" href="https://en.wikipedia.org/wiki/Xmpp">XMPP</a> on the other hand, is the protocol that enables instant messaging, and
......@@ -242,7 +243,7 @@ includes a connection manager (but you have to enable it).</p>
This connection manager is for testing purposes only, please don&#8217;t use it in
production.</p>
<div class="section" id="overcoming-cross-domain-request-restrictions">
<h3><a class="toc-backref" href="#id8">Overcoming cross-domain request restrictions</a><a class="headerlink" href="#overcoming-cross-domain-request-restrictions" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id9">Overcoming cross-domain request restrictions</a><a class="headerlink" href="#overcoming-cross-domain-request-restrictions" title="Permalink to this headline"></a></h3>
<p>The domain of the <em>Converse.js</em> demo is <em>conversejs.org</em>, but the domain of the connection manager is <em>opkode.im</em>.
HTTP requests are made by <em>Converse.js</em> to the connection manager via XmlHttpRequests (XHR).
Until recently, it was not possible to make such requests to a different domain
......@@ -291,9 +292,9 @@ the cross-domain restriction is <tt class="docutils literal"><span class="pre">m
</div>
</div>
<div class="section" id="server-side-authentication">
<h2><a class="toc-backref" href="#id9">Server-side authentication</a><a class="headerlink" href="#server-side-authentication" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id10">Server-side authentication</a><a class="headerlink" href="#server-side-authentication" title="Permalink to this headline"></a></h2>
<div class="section" id="prebinding-and-single-session-support">
<span id="session-support"></span><h3><a class="toc-backref" href="#id10">Prebinding and Single Session Support</a><a class="headerlink" href="#prebinding-and-single-session-support" title="Permalink to this headline"></a></h3>
<span id="session-support"></span><h3><a class="toc-backref" href="#id11">Prebinding and Single Session Support</a><a class="headerlink" href="#prebinding-and-single-session-support" title="Permalink to this headline"></a></h3>
<p>It&#8217;s possible to enable single-site login, whereby users already
authenticated in your website will also automatically be logged in on the chat server,</p>
<p>This session should also persist across page loads. In other words, we don&#8217;t
......@@ -350,7 +351,7 @@ Additionally you need to pass in valid <strong>jid</strong>, <strong>sid</strong
</div>
</div>
<div class="section" id="example-code-for-server-side-prebinding">
<h3><a class="toc-backref" href="#id11">Example code for server-side prebinding</a><a class="headerlink" href="#example-code-for-server-side-prebinding" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id12">Example code for server-side prebinding</a><a class="headerlink" href="#example-code-for-server-side-prebinding" title="Permalink to this headline"></a></h3>
<ul>
<li><dl class="first docutils">
<dt>PHP:</dt>
......@@ -368,14 +369,14 @@ Michael Weibel and the folks from Candy chat.</p>
</ul>
</div>
<div class="section" id="setting-up-a-bosh-server">
<h3><a class="toc-backref" href="#id12">Setting up a BOSH server</a><a class="headerlink" href="#setting-up-a-bosh-server" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id13">Setting up a BOSH server</a><a class="headerlink" href="#setting-up-a-bosh-server" title="Permalink to this headline"></a></h3>
<p>The <a class="reference external" href="http://movim.eu/">Movim</a> project wiki has a very thorough page on setting up a BOSH server for
a wide variety of standalone or XMPP servers.</p>
<p><a class="reference external" href="http://wiki.movim.eu/manual:bosh_servers">http://wiki.movim.eu/manual:bosh_servers</a></p>
</div>
</div>
<div class="section" id="facebook-integration">
<h2><a class="toc-backref" href="#id13">Facebook integration</a><a class="headerlink" href="#facebook-integration" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id14">Facebook integration</a><a class="headerlink" href="#facebook-integration" title="Permalink to this headline"></a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">It should be possible to integrate Converse.js with Facebook chat, and
......@@ -418,9 +419,9 @@ Until then, people will have to do this themselves.</p>
</div>
</div>
<div class="section" id="features">
<h1><a class="toc-backref" href="#id14">Features</a><a class="headerlink" href="#features" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id15">Features</a><a class="headerlink" href="#features" title="Permalink to this headline"></a></h1>
<div class="section" id="off-the-record-encryption">
<h2><a class="toc-backref" href="#id15">Off-the-record encryption</a><a class="headerlink" href="#off-the-record-encryption" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id16">Off-the-record encryption</a><a class="headerlink" href="#off-the-record-encryption" title="Permalink to this headline"></a></h2>
<p>Converse.js supports <a class="reference external" href="https://otr.cypherpunks.ca/">Off-the-record (OTR)</a>
encrypted messaging.</p>
<p>The OTR protocol not only <strong>encrypts your messages</strong>, it provides ways to
......@@ -443,13 +444,13 @@ communications privacy, then you&#8217;re much better off using native software.
</div>
</div>
<div class="section" id="development">
<h1><a class="toc-backref" href="#id16">Development</a><a class="headerlink" href="#development" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id17">Development</a><a class="headerlink" href="#development" title="Permalink to this headline"></a></h1>
<p>If you want to work with the non-minified Javascript and CSS files you&#8217;ll soon
notice that there are references to a missing <em>components</em> folder. Please
follow the instructions below to create this folder and fetch Converse&#8217;s
3rd-party dependencies.</p>
<div class="section" id="install-the-development-and-front-end-dependencies">
<h2><a class="toc-backref" href="#id17">Install the development and front-end dependencies</a><a class="headerlink" href="#install-the-development-and-front-end-dependencies" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id18">Install the development and front-end dependencies</a><a class="headerlink" href="#install-the-development-and-front-end-dependencies" title="Permalink to this headline"></a></h2>
<p>We use development tools (<a class="reference external" href="http://gruntjs.com">Grunt</a> and <a class="reference external" href="http://bower.io">Bower</a>)
which depend on Node.js and npm (the Node package manager).</p>
<p>If you don&#8217;t have Node.js installed, you can download and install the latest
......@@ -482,7 +483,7 @@ Converse.js directly depends and which will therefore be loaded in the browser.<
</ul>
</div>
<div class="section" id="with-amd-and-require-js-recommended">
<h2><a class="toc-backref" href="#id18">With AMD and require.js (recommended)</a><a class="headerlink" href="#with-amd-and-require-js-recommended" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id19">With AMD and require.js (recommended)</a><a class="headerlink" href="#with-amd-and-require-js-recommended" title="Permalink to this headline"></a></h2>
<p>Converse.js uses <a class="reference external" href="http://requirejs.org">require.js</a> to asynchronously load dependencies.</p>
<p>If you want to develop or customize converse.js, you&#8217;ll want to load the
non-minified javascript files.</p>
......@@ -495,7 +496,7 @@ attribute on the <em>script</em> tag), which will in turn cause converse.js to b
parsed.</p>
</div>
<div class="section" id="without-amd-and-require-js">
<h2><a class="toc-backref" href="#id19">Without AMD and require.js</a><a class="headerlink" href="#without-amd-and-require-js" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id20">Without AMD and require.js</a><a class="headerlink" href="#without-amd-and-require-js" title="Permalink to this headline"></a></h2>
<p>Converse.js can also be used without require.js. If you for some reason prefer
to use it this way, please refer to
<a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/non_amd.html">non_amd.html</a>
......@@ -503,9 +504,9 @@ for an example of how and in what order all the Javascript files that converse.j
depends on need to be loaded.</p>
</div>
<div class="section" id="before-submitting-a-pull-request">
<h2><a class="toc-backref" href="#id20">Before submitting a pull request</a><a class="headerlink" href="#before-submitting-a-pull-request" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id21">Before submitting a pull request</a><a class="headerlink" href="#before-submitting-a-pull-request" title="Permalink to this headline"></a></h2>
<div class="section" id="add-tests-for-your-bugfix-or-feature">
<h3><a class="toc-backref" href="#id21">Add tests for your bugfix or feature</a><a class="headerlink" href="#add-tests-for-your-bugfix-or-feature" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id22">Add tests for your bugfix or feature</a><a class="headerlink" href="#add-tests-for-your-bugfix-or-feature" title="Permalink to this headline"></a></h3>
<p>Add a test for any bug fixed or feature added. We use Jasmine
for testing.</p>
<p>Take a look at <tt class="docutils literal"><span class="pre">tests.html</span></tt> and <tt class="docutils literal"><span class="pre">spec/MainSpec.js</span></tt> to see how
......@@ -514,7 +515,7 @@ the tests are implemented.</p>
<a class="reference external" href="http://opkode.com/contact">contact me</a> and I&#8217;ll be happy to help.</p>
</div>
<div class="section" id="check-that-the-tests-pass">
<h3><a class="toc-backref" href="#id22">Check that the tests pass</a><a class="headerlink" href="#check-that-the-tests-pass" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id23">Check that the tests pass</a><a class="headerlink" href="#check-that-the-tests-pass" title="Permalink to this headline"></a></h3>
<p>Check that the Jasmine tests complete sucessfully. Open
<a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/tests.html">tests.html</a>
in your browser, and the tests will run automatically.</p>
......@@ -523,7 +524,7 @@ in your browser, and the tests will run automatically.</p>
</div>
</div>
<div class="section" id="check-your-code-for-errors-or-bad-habits-by-running-jshint">
<h3><a class="toc-backref" href="#id23">Check your code for errors or bad habits by running JSHint</a><a class="headerlink" href="#check-your-code-for-errors-or-bad-habits-by-running-jshint" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id24">Check your code for errors or bad habits by running JSHint</a><a class="headerlink" href="#check-your-code-for-errors-or-bad-habits-by-running-jshint" title="Permalink to this headline"></a></h3>
<p><a class="reference external" href="http://jshint.com">JSHint</a> will do a static analysis of your code and hightlight potential errors
and/or bad habits.</p>
<div class="highlight-python"><pre>grunt jshint</pre>
......@@ -534,9 +535,9 @@ and/or bad habits.</p>
</div>
</div>
<div class="section" id="minification">
<h2><a class="toc-backref" href="#id24">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id25">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline"></a></h2>
<div class="section" id="minifying-javascript-and-css">
<h3><a class="toc-backref" href="#id25">Minifying Javascript and CSS</a><a class="headerlink" href="#minifying-javascript-and-css" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id26">Minifying Javascript and CSS</a><a class="headerlink" href="#minifying-javascript-and-css" title="Permalink to this headline"></a></h3>
<p>Please make sure to read the section <a class="reference internal" href="#development">Development</a> and that you have installed
all development dependencies (long story short, you can run <tt class="docutils literal"><span class="pre">npm</span> <span class="pre">install</span></tt>
and then <tt class="docutils literal"><span class="pre">grunt</span> <span class="pre">fetch</span></tt>).</p>
......@@ -553,7 +554,7 @@ using <a class="reference external" href="https://github.com/jrburke/almond">alm
</div>
</div>
<div class="section" id="translations">
<h2><a class="toc-backref" href="#id26">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id27">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline"></a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Translations take up a lot of space and will bloat your minified file.
......@@ -630,18 +631,18 @@ those hoops you had to jump through.</p>
</div>
</div>
<div class="section" id="troubleshooting">
<h1><a class="toc-backref" href="#id27">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id28">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline"></a></h1>
<div class="section" id="conflicts-with-other-javascript-libraries">
<h2><a class="toc-backref" href="#id28">Conflicts with other Javascript libraries</a><a class="headerlink" href="#conflicts-with-other-javascript-libraries" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id29">Conflicts with other Javascript libraries</a><a class="headerlink" href="#conflicts-with-other-javascript-libraries" title="Permalink to this headline"></a></h2>
<div class="section" id="problem">
<h3><a class="toc-backref" href="#id29">Problem:</a><a class="headerlink" href="#problem" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id30">Problem:</a><a class="headerlink" href="#problem" title="Permalink to this headline"></a></h3>
<p>You are using other Javascript libraries (like JQuery plugins), and
get errors like these in your browser console:</p>
<div class="highlight-python"><pre>Uncaught TypeError: Object [object Object] has no method 'xxx' from example.js</pre>
</div>
</div>
<div class="section" id="solution">
<h3><a class="toc-backref" href="#id30">Solution:</a><a class="headerlink" href="#solution" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id31">Solution:</a><a class="headerlink" href="#solution" title="Permalink to this headline"></a></h3>
<p>First, find out which object is referred to by <tt class="docutils literal"><span class="pre">Object</span> <span class="pre">[object</span> <span class="pre">Object]</span></tt>.</p>
<p>It will probably be the jQuery object <tt class="docutils literal"><span class="pre">$</span></tt> or perhaps the underscore.js object <tt class="docutils literal"><span class="pre">_</span></tt>.</p>
<p>For the purpose of demonstration, I&#8217;m going to assume its <tt class="docutils literal"><span class="pre">$</span></tt>, but the same
......@@ -683,11 +684,11 @@ jQuery plugins must load after jQuery).</p>
</div>
</div>
<div class="section" id="events">
<h1><a class="toc-backref" href="#id31">Events</a><a class="headerlink" href="#events" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id32">Events</a><a class="headerlink" href="#events" title="Permalink to this headline"></a></h1>
<p>Converse.js emits events to which you can subscribe from your own Javascript.</p>
<p>Concerning events, the following methods are available:</p>
<div class="section" id="event-methods">
<h2><a class="toc-backref" href="#id32">Event Methods</a><a class="headerlink" href="#event-methods" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id33">Event Methods</a><a class="headerlink" href="#event-methods" title="Permalink to this headline"></a></h2>
<ul>
<li><p class="first"><strong>on(eventName, callback)</strong>:</p>
<blockquote>
......@@ -731,7 +732,7 @@ exactly once.</p>
</ul>
</div>
<div class="section" id="event-types">
<h2><a class="toc-backref" href="#id33">Event Types</a><a class="headerlink" href="#event-types" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id34">Event Types</a><a class="headerlink" href="#event-types" title="Permalink to this headline"></a></h2>
<p>Here are the different events that are emitted:</p>
<table border="1" class="docutils">
<colgroup>
......@@ -811,7 +812,7 @@ exactly once.</p>
</div>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id34">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id35">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1>
<p>The included minified JS and CSS files can be used for demoing or testing, but
you&#8217;ll want to configure <em>Converse.js</em> to suit your needs before you deploy it
on your website.</p>
......@@ -825,29 +826,34 @@ all the available configuration settings.</p>
JS file so that it will include the new settings. Please refer to the
<a class="reference internal" href="#minification">Minification</a> section for more info on how to do this.</p>
<div class="section" id="configuration-variables">
<h2><a class="toc-backref" href="#id35">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id36">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline"></a></h2>
<div class="section" id="allow-contact-requests">
<h3><a class="toc-backref" href="#id36">allow_contact_requests</a><a class="headerlink" href="#allow-contact-requests" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
<h3><a class="toc-backref" href="#id37">allow_contact_requests</a><a class="headerlink" href="#allow-contact-requests" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
<p>Allow users to add one another as contacts. If this is set to false, the
<strong>Add a contact</strong> widget, <strong>Contact Requests</strong> and <strong>Pending Contacts</strong> roster
sections will all not appear. Additionally, all incoming contact requests will be
ignored.</p>
</div>
<div class="section" id="allow-muc">
<h3><a class="toc-backref" href="#id37">allow_muc</a><a class="headerlink" href="#allow-muc" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
<h3><a class="toc-backref" href="#id38">allow_muc</a><a class="headerlink" href="#allow-muc" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
<p>Allow multi-user chat (muc) in chatrooms. Setting this to <tt class="docutils literal"><span class="pre">false</span></tt> will remove
the <tt class="docutils literal"><span class="pre">Chatrooms</span></tt> tab from the control box.</p>
</div>
<div class="section" id="id2">
<h3><a class="toc-backref" href="#id39">allow_muc</a><a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
<p>Allow Off-the-record encryption of single-user chat messages.</p>
</div>
<div class="section" id="animate">
<h3><a class="toc-backref" href="#id38">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
<h3><a class="toc-backref" href="#id40">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
<p>Show animations, for example when opening and closing chat boxes.</p>
</div>
<div class="section" id="auto-list-rooms">
<h3><a class="toc-backref" href="#id39">auto_list_rooms</a><a class="headerlink" href="#auto-list-rooms" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id41">auto_list_rooms</a><a class="headerlink" href="#auto-list-rooms" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>If true, and the XMPP server on which the current user is logged in supports
multi-user chat, then a list of rooms on that server will be fetched.</p>
<p>Not recommended for servers with lots of chat rooms.</p>
......@@ -856,25 +862,25 @@ features, number of occupants etc.), so on servers with many rooms this
option will create lots of extra connection traffic.</p>
</div>
<div class="section" id="auto-reconnect">
<h3><a class="toc-backref" href="#id40">auto_reconnect</a><a class="headerlink" href="#auto-reconnect" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
<h3><a class="toc-backref" href="#id42">auto_reconnect</a><a class="headerlink" href="#auto-reconnect" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
<p>Automatically reconnect to the XMPP server if the connection drops
unexpectedly.</p>
</div>
<div class="section" id="auto-subscribe">
<h3><a class="toc-backref" href="#id41">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id43">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>If true, the user will automatically subscribe back to any contact requests.</p>
</div>
<div class="section" id="bosh-service-url">
<h3><a class="toc-backref" href="#id42">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id44">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline"></a></h3>
<p>Connections to an XMPP server depend on a BOSH connection manager which acts as
a middle man between HTTP and XMPP.</p>
<p>See <a class="reference external" href="http://metajack.im/2008/09/08/which-bosh-server-do-you-need">here</a> for more information.</p>
</div>
<div class="section" id="cache-otr-key">
<h3><a class="toc-backref" href="#id43">cache_otr_key</a><a class="headerlink" href="#cache-otr-key" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id45">cache_otr_key</a><a class="headerlink" href="#cache-otr-key" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>Let the <a class="reference external" href="https://otr.cypherpunks.ca">OTR (Off-the-record encryption)</a> private
key be cached in your browser&#8217;s session storage.</p>
<p>The browser&#8217;s session storage persists across page loads but is deleted once
......@@ -892,18 +898,18 @@ current session. Previous sessions however cannot be decrypted.</p>
</div>
</div>
<div class="section" id="debug">
<h3><a class="toc-backref" href="#id44">debug</a><a class="headerlink" href="#debug" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id46">debug</a><a class="headerlink" href="#debug" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>If set to true, debugging output will be logged to the browser console.</p>
</div>
<div class="section" id="enable-message-carbons">
<h3><a class="toc-backref" href="#id45">enable_message_carbons</a><a class="headerlink" href="#enable-message-carbons" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id47">enable_message_carbons</a><a class="headerlink" href="#enable-message-carbons" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>Support for <a class="reference external" href="https://xmpp.org/extensions/xep-0280.html">XEP-0280: Message Carbons</a></p>
</div>
<div class="section" id="expose-rid-and-sid">
<h3><a class="toc-backref" href="#id46">expose_rid_and_sid</a><a class="headerlink" href="#expose-rid-and-sid" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id48">expose_rid_and_sid</a><a class="headerlink" href="#expose-rid-and-sid" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>Allow the prebind tokens, RID (request ID) and SID (session ID), to be exposed
globally via the API. This allows other scripts served on the same page to use
these values.</p>
......@@ -911,8 +917,8 @@ these values.</p>
and inject fake chat messages.</p>
</div>
<div class="section" id="forward-messages">
<h3><a class="toc-backref" href="#id47">forward_messages</a><a class="headerlink" href="#forward-messages" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id49">forward_messages</a><a class="headerlink" href="#forward-messages" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>If set to <tt class="docutils literal"><span class="pre">true</span></tt>, sent messages will also be forwarded to other connected
XMPP resources (e.g. chat clients) of the same user.</p>
<p>This is useful for example if converse.js is running in multiple tabs of the
......@@ -920,25 +926,25 @@ browser and you want sent messages to appear in all of them.</p>
<p>See also <a class="reference external" href="http://www.xmpp.org/extensions/xep-0297.html">XEP 0297: Stanza Forwarding</a></p>
</div>
<div class="section" id="fullname">
<h3><a class="toc-backref" href="#id48">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id50">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline"></a></h3>
<p>If you are using prebinding, can specify the fullname of the currently
logged in user, otherwise the user&#8217;s vCard will be fetched.</p>
</div>
<div class="section" id="hide-muc-server">
<h3><a class="toc-backref" href="#id49">hide_muc_server</a><a class="headerlink" href="#hide-muc-server" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id51">hide_muc_server</a><a class="headerlink" href="#hide-muc-server" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>Hide the <tt class="docutils literal"><span class="pre">server</span></tt> input field of the form inside the <tt class="docutils literal"><span class="pre">Room</span></tt> panel of the
controlbox. Useful if you want to restrict users to a specific XMPP server of
your choosing.</p>
</div>
<div class="section" id="i18n">
<h3><a class="toc-backref" href="#id50">i18n</a><a class="headerlink" href="#i18n" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id52">i18n</a><a class="headerlink" href="#i18n" title="Permalink to this headline"></a></h3>
<p>Specify the locale/language. The language must be in the <tt class="docutils literal"><span class="pre">locales</span></tt> object. Refer to
<tt class="docutils literal"><span class="pre">./locale/locales.js</span></tt> to see which locales are supported.</p>
</div>
<div class="section" id="prebind">
<h3><a class="toc-backref" href="#id51">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id53">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>Use this option when you want to attach to an existing XMPP connection that was
already authenticated (usually on the backend before page load).</p>
<p>This is useful when you don&#8217;t want to render the login form on the chat control
......@@ -950,8 +956,8 @@ values as <tt class="docutils literal"><span class="pre">jid</span></tt>, <tt cl
<p>Additionally, you have to specify <tt class="docutils literal"><span class="pre">bosh_service_url</span></tt>.</p>
</div>
<div class="section" id="show-controlbox-by-default">
<h3><a class="toc-backref" href="#id52">show_controlbox_by_default</a><a class="headerlink" href="#show-controlbox-by-default" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id54">show_controlbox_by_default</a><a class="headerlink" href="#show-controlbox-by-default" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>The &#8220;controlbox&#8221; refers to the special chatbox containing your contacts roster,
status widget, chatrooms and other controls.</p>
<p>By default this box is hidden and can be toggled by clicking on any element in
......@@ -959,42 +965,67 @@ the page with class <em>toggle-online-users</em>.</p>
<p>If this options is set to true, the controlbox will by default be shown upon
page load.</p>
</div>
<div class="section" id="show-call-button">
<h3><a class="toc-backref" href="#id53">show_call_button</a><a class="headerlink" href="#show-call-button" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>Enable to display a call button on the chatbox toolbar.</p>
<p>When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.</p>
<div class="highlight-python"><pre>converse.on('onCallButtonClicked', function(event, data) {
console.log('Call button was clicked.');
console.log('Strophe connection is', data.connection);
console.log('Bare buddy JID is', data.model.get('jid'));
// ... Third-party library code ...
});</pre>
</div>
</div>
<div class="section" id="show-only-online-users">
<h3><a class="toc-backref" href="#id54">show_only_online_users</a><a class="headerlink" href="#show-only-online-users" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id55">show_only_online_users</a><a class="headerlink" href="#show-only-online-users" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>If set to <tt class="docutils literal"><span class="pre">true</span></tt>, only online users will be shown in the contacts roster.
Users with any other status (e.g. away, busy etc.) will not be shown.</p>
</div>
<div class="section" id="use-otr-by-default">
<h3><a class="toc-backref" href="#id55">use_otr_by_default</a><a class="headerlink" href="#use-otr-by-default" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id56">use_otr_by_default</a><a class="headerlink" href="#use-otr-by-default" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>If set to <tt class="docutils literal"><span class="pre">true</span></tt>, Converse.js will automatically try to initiate an OTR (off-the-record)
encrypted chat session every time you open a chat box.</p>
</div>
<div class="section" id="use-vcards">
<h3><a class="toc-backref" href="#id56">use_vcards</a><a class="headerlink" href="#use-vcards" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">true</span></tt></p>
<h3><a class="toc-backref" href="#id57">use_vcards</a><a class="headerlink" href="#use-vcards" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
<p>Determines whether the XMPP server will be queried for roster contacts&#8217; VCards
or not. VCards contain extra personal information such as your fullname and
avatar image.</p>
</div>
<div class="section" id="visible-toolbar-buttons">
<h3><a class="toc-backref" href="#id58">visible_toolbar_buttons</a><a class="headerlink" href="#visible-toolbar-buttons" title="Permalink to this headline"></a></h3>
<p>Default:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&#39;emoticons&#39;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s">&#39;call&#39;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s">&#39;clear&#39;</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Allows you to show or hide buttons on the chat boxes&#8217; toolbars.</p>
<ul>
<li><dl class="first docutils">
<dt><em>emoticons</em>:</dt>
<dd><p class="first last">Enables rendering of emoticons and provides a toolbar button for choosing them.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><em>call</em>:</dt>
<dd><p class="first">Provides a button with a picture of a telephone on it.
When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.</p>
<div class="last highlight-python"><pre>converse.on('onCallButtonClicked', function(event, data) {
console.log('Strophe connection is', data.connection);
console.log('Bare buddy JID is', data.model.get('jid'));
// ... Third-party library code ...
});</pre>
</div>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><em>clear</em>:</dt>
<dd><p class="first last">Provides a button for clearing messages from a chat box.</p>
</dd>
</dl>
</li>
</ul>
</div>
<div class="section" id="xhr-custom-status">
<h3><a class="toc-backref" href="#id57">xhr_custom_status</a><a class="headerlink" href="#xhr-custom-status" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id59">xhr_custom_status</a><a class="headerlink" href="#xhr-custom-status" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).</p>
......@@ -1003,20 +1034,20 @@ avatar image.</p>
remote server.</p>
</div>
<div class="section" id="xhr-custom-status-url">
<h3><a class="toc-backref" href="#id58">xhr_custom_status_url</a><a class="headerlink" href="#xhr-custom-status-url" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id60">xhr_custom_status_url</a><a class="headerlink" href="#xhr-custom-status-url" title="Permalink to this headline"></a></h3>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).</p>
</div>
<p>Default = Empty string</p>
<p>Default: Empty string</p>
<p>Used only in conjunction with <tt class="docutils literal"><span class="pre">xhr_custom_status</span></tt>.</p>
<p>This is the URL to which the AJAX POST request to set the user&#8217;s custom status
message will be made.</p>
<p>The message itself is sent in the request under the key <tt class="docutils literal"><span class="pre">msg</span></tt>.</p>
</div>
<div class="section" id="xhr-user-search">
<h3><a class="toc-backref" href="#id59">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline"></a></h3>
<p>Default = <tt class="docutils literal"><span class="pre">false</span></tt></p>
<h3><a class="toc-backref" href="#id61">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).</p>
......@@ -1032,12 +1063,12 @@ message will be made.</p>
corresponds to a matched user and needs the keys <tt class="docutils literal"><span class="pre">id</span></tt> and <tt class="docutils literal"><span class="pre">fullname</span></tt>.</p>
</div>
<div class="section" id="xhr-user-search-url">
<h3><a class="toc-backref" href="#id60">xhr_user_search_url</a><a class="headerlink" href="#xhr-user-search-url" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id62">xhr_user_search_url</a><a class="headerlink" href="#xhr-user-search-url" title="Permalink to this headline"></a></h3>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).</p>
</div>
<p>Default = Empty string</p>
<p>Default: Empty string</p>
<p>Used only in conjunction with <tt class="docutils literal"><span class="pre">xhr_user_search</span></tt>.</p>
<p>This is the URL to which an AJAX GET request will be made to fetch user data from your remote server.
The query string will be included in the request with <tt class="docutils literal"><span class="pre">q</span></tt> as its key.</p>
......
docs/html/searchindex.js
View file @ 517e6001
Search.setIndex({objects:{},terms:{all:0,code:0,partial:0,queri:0,lack:0,webchat:0,follow:0,row:0,privat:0,typeerror:0,depend:0,sensit:0,punjab:0,cach:0,buddi:0,under:0,sens:0,spec:0,sent:0,global:0,everi:0,string:0,fals:0,multi:0,facebook:0,jack:0,veri:0,retriev:0,tri:0,button:0,messagetext:0,list:0,factori:0,"try":0,item:0,sane:0,div:0,pleas:0,prevent:0,xhr_user_search_url:0,almond:0,focu:0,past:0,second:0,pass:0,download:0,further:0,fullnam:0,click:0,folk:0,even:0,index:0,what:0,hide:0,appear:0,section:0,abl:0,access:0,delet:0,use_otr_by_default:0,"new":0,net:0,"public":0,widget:0,themselv:0,messagexml:0,gener:0,here:0,bodi:0,middl:0,let:0,modifi:0,valu:0,box:0,great:0,convers:0,mysit:0,reason:0,fetch:0,implement:0,sorri:0,chanc:0,via:0,although:0,danger:0,apach:0,prefer:0,put:0,href:0,fake:0,auto_list_room:0,instal:0,establish:0,getsess:0,from:0,zip:0,commun:0,doubl:0,two:0,websit:0,few:0,stylesheet:0,busi:0,call:0,recommend:0,msg:0,type:0,until:0,tightli:0,more:0,peopl:0,line:0,notic:0,particular:0,vcard:0,must:0,account:0,word:0,room:0,work:0,uniqu:0,dev:0,xhr:0,legwork:0,can:0,lc_messag:0,purpos:0,root:0,blogpost:0,control:0,quickstart:0,give:0,challeng:0,share:0,templat:0,critic:0,tag:0,proprietari:0,explor:0,onlin:0,occup:0,end:0,goal:0,thing:0,anoth:0,deniabl:0,snippet:0,how:0,bosh_serv:0,sid:0,instead:0,css:0,updat:0,npm:0,regener:0,product:0,resourc:0,haven:0,after:0,usabl:0,befor:0,allow_contact_request:0,multipl:0,underscor:0,data:0,demonstr:0,man:0,repo:0,"short":0,attempt:0,practic:0,third:0,seriou:0,secur:0,show_controlbox_by_default:0,correspond:0,element:0,caus:0,inform:0,show_only_online_us:0,allow:0,parti:0,mechan:0,order:0,talk:0,feedback:0,chatbox:0,xmpp:0,over:0,move:0,becaus:0,through:0,reconnect:0,paramet:0,streamlin:0,write:0,jid:0,"8147a27e4a7f9b55ffc85c2683f9529a":0,render:0,fit:0,fix:0,better:0,window:0,pend:0,persist:0,hidden:0,main:0,might:0,them:0,anim:0,"return":0,thei:0,python:0,initi:0,onmessag:0,onbuddystatusmessagechang:0,expose_rid_and_sid:0,front:0,now:0,introduct:0,jump:0,name:0,edit:0,troubleshoot:0,revers:0,crypto:0,authent:0,separ:0,xhr_custom_statu:0,ejabberd:0,each:0,debug:0,side:0,mean:0,domain:0,michael:0,individu:0,idea:0,realli:0,"static":0,connect:0,our:0,happen:0,patch:0,extract:0,event:0,special:0,out:0,variabl:0,shown:0,"3rd":0,space:0,miss:0,proxy_pass:0,content:0,rel:0,internet:0,got:0,merg:0,plural:0,correct:0,po2json:0,model:0,proxi:0,insid:0,state:0,standard:0,standalon:0,ajax:0,ask:0,succesfulli:0,afterward:0,xhr_custom_status_url:0,could:0,keep:0,turn:0,perhap:0,imposs:0,first:0,origin:0,softwar:0,directli:0,malici:0,onc:0,hoop:0,lastnam:0,number:0,yourself:0,restrict:0,instruct:0,alreadi:0,done:0,"long":0,onchatboxclos:0,owner:0,custom:0,jabber:0,suffic:0,differ:0,script:0,top:0,attack:0,messag:0,attach:0,stori:0,jed:0,privaci:0,"final":0,listen:0,luckili:0,consol:0,option:0,tool:0,specifi:0,part:0,bower:0,exactli:0,than:0,serv:0,wide:0,kind:0,bloat:0,provid:0,remov:0,project:0,bridg:0,bind:0,someothersit:0,browser:0,pre:0,analysi:0,sai:0,forward_messag:0,credenti:0,saa:0,modern:0,ani:0,packag:0,increment:0,tabl:0,need:0,moffitt:0,django:0,bosh_service_url:0,prebind:0,callback:0,latter:0,thorough:0,port:0,note:0,also:0,exampl:0,take:0,which:0,singl:0,therefor:0,sure:0,roster:0,unsur:0,previou:0,reach:0,most:0,eavesdropp:0,rewriterul:0,homepag:0,onchatboxtoggl:0,don:0,use_vcard:0,url:0,request:0,doe:0,runtim:0,determin:0,pars:0,latest:0,xdomainrequest:0,devdepend:0,show:0,german:0,text:0,server_nam:0,session:0,identifi:0,fine:0,find:0,help:0,xml:0,current:0,onli:0,grunt:0,locat:0,execut:0,configur:0,solut:0,stanza:0,should:0,version:0,folder:0,local:0,meant:0,get:0,stop:0,soon:0,opkod:0,nativ:0,cannot:0,cryptographi:0,requir:0,show_call_button:0,enabl:0,emb:0,mainspec:0,whenev:0,achiev:0,method:0,remot:0,bad:0,integr:0,though:0,contain:0,xep:0,where:0,view:0,wiki:0,set:0,habit:0,stroph:0,see:0,bare:0,result:0,close:0,calendar:0,eventnam:0,best:0,concern:0,jqueri:0,statu:0,said:0,kei:0,inconveni:0,someth:0,written:0,muc:0,between:0,awai:0,experi:0,jasmin:0,across:0,attribut:0,verifi:0,appreci:0,extend:0,screen:0,javascript:0,conjunct:0,job:0,entir:0,bosh:0,otherwis:0,"5e64a30272af065bd72258c565a03f2f":0,carbon:0,cache_otr_kei:0,both:0,cor:0,instant:0,shortliv:0,conversej:0,avatar:0,etc:0,grain:0,mani:0,login:0,com:0,load:0,simpli:0,pot:0,onreconnect:0,solv:0,non:0,deploi:0,assum:0,malleabl:0,backend:0,quit:0,enable_message_carbon:0,sucessfulli:0,addition:0,rebuild:0,due:0,been:0,compon:0,json:0,much:0,toolbar:0,subscrib:0,session_kei:0,fire:0,imag:0,xxx:0,rubi:0,convert:0,minifi:0,togeth:0,input:0,i18n:0,otr:0,plausibl:0,present:0,"case":0,myself:0,ident:0,look:0,servic:0,plugin:0,defin:0,"while":0,abov:0,error:0,howev:0,hightlight:0,have:0,helper:0,demo:0,auto_subscrib:0,site:0,oncallbuttonclick:0,itself:0,incom:0,rid:0,develop:0,harsh:0,open:0,minim:0,receiv:0,media:0,make:0,format:0,minif:0,cross:0,same:0,webpag:0,onconnectfacebook:0,html:0,unexpectedli:0,chatroom:0,document:0,medit:0,conflict:0,complet:0,signon:0,http:0,webserv:0,optim:0,upon:0,someon:0,hand:0,fairli:0,"50kb":0,user:0,uncaught:0,php:0,xhr_user_search:0,cssmin:0,recent:0,weibel:0,stateless:0,off:0,bewar:0,choos:0,firstli:0,markup:0,min:0,well:0,without:0,thought:0,person:0,contact:0,command:0,wherebi:0,thi:0,onmessagesend:0,everyth:0,usual:0,plural_form:0,protocol:0,just:0,tip:0,onstatuschang:0,jshint:0,file:0,languag:0,web:0,fraught:0,xmlhttprequest:0,expos:0,field:0,extra:0,had:0,onchatboxopen:0,desktop:0,add:0,valid:0,non_amd:0,versa:0,primit:0,els:0,match:0,build:0,applic:0,nplural:0,secreci:0,read:0,amd:0,nginx:0,traffic:0,know:0,press:0,xss:0,like:0,specif:0,reload:0,manual:0,server:0,benefit:0,api:0,either:0,output:0,perfect:0,page:0,candi:0,facebookconnect:0,right:0,who:0,deal:0,duck:0,some:0,back:0,drop:0,librari:0,bottom:0,avoid:0,deploy:0,rewriteengin:0,track:0,allow_otr:0,inject:0,overcom:0,oniniti:0,localhost:0,refer:0,somehow:0,plu:0,object:0,run:0,host:0,repositori:0,post:0,appli:0,panel:0,src:0,about:0,firstnam:0,controlbox:0,unfortun:0,issu:0,stand:0,act:0,client:0,own:0,curiou:0,within:0,encod:0,harm:0,automat:0,empti:0,onreadi:0,wrap:0,chang:0,storag:0,your:0,manag:0,git:0,log:0,wai:0,aren:0,transfer:0,support:0,submit:0,happi:0,avail:0,trigger:0,includ:0,lot:0,suit:0,forward:0,"function":0,head:0,properli:0,form:0,bundl:0,maxim:0,link:0,translat:0,synonym:0,cryptograph:0,inlin:0,"true":0,bug:0,congratul:0,requirej:0,info:0,pull:0,made:0,dirti:0,locale_data:0,possibl:0,whether:0,bugfix:0,displai:0,asynchron:0,record:0,below:0,those:0,toggl:0,auto_reconnect:0,problem:0,emit:0,expect:0,onrosterviewupd:0,featur:0,constant:0,creat:0,movim:0,decrypt:0,doesn:0,mode:0,msgmerg:0,exist:0,chat:0,face:0,check:0,probabl:0,tab:0,encrypt:0,want:0,onrost:0,pat:0,when:0,detail:0,gettext:0,"default":0,other:0,onchatboxfocus:0,rememb:0,varieti:0,test:0,you:0,servernam:0,nice:0,node:0,intend:0,onbuddystatuschang:0,onstatusmessagechang:0,org:0,"class":0,releas:0,consid:0,hide_muc_serv:0,stai:0,lang:0,longer:0,vice:0,directori:0,virtualhost:0,getjson:0,rule:0,allow_muc:0,ignor:0,token:0,potenti:0,time:0},objtypes:{},titles:["Quickstart (to get a demo up and running)"],objnames:{},filenames:["index"]})
\ No newline at end of file
Search.setIndex({objects:{},terms:{all:0,code:0,partial:0,use_otr_by_default:0,queri:0,lack:0,webchat:0,follow:0,row:0,privat:0,typeerror:0,depend:0,onmessagesend:0,sensit:0,punjab:0,cach:0,buddi:0,under:0,sens:0,spec:0,sent:0,global:0,everi:0,string:0,fals:0,myself:0,ident:0,facebook:0,jack:0,veri:0,retriev:0,tri:0,button:0,messagetext:0,list:0,correct:0,"try":0,item:0,sane:0,div:0,refer:0,pleas:0,prevent:0,xhr_user_search_url:0,almond:0,focu:0,past:0,second:0,possibl:0,pass:0,download:0,further:0,fullnam:0,click:0,folk:0,even:0,index:0,what:0,hide:0,appear:0,section:0,abl:0,access:0,delet:0,version:0,"new":0,net:0,"public":0,widget:0,themselv:0,messagexml:0,gener:0,cal:[],here:0,bodi:0,middl:0,let:0,modifi:0,valu:0,box:0,great:0,convers:0,mysit:0,ajax:0,onbuddystatuschang:0,fetch:0,implement:0,sorri:0,chanc:0,via:0,repositori:0,danger:0,solut:0,prefer:0,ask:0,href:0,fake:0,auto_list_room:0,instal:0,should:0,establish:0,getsess:0,from:0,zip:0,commun:0,doubl:0,two:0,websit:0,few:0,stylesheet:0,call:0,recommend:0,msg:0,type:0,until:0,tightli:0,more:0,emoticon:0,peopl:0,notic:0,site:0,particular:0,vcard:0,must:0,account:0,word:0,room:0,work:0,uniqu:0,dev:0,xhr:0,can:0,lc_messag:0,purpos:0,root:0,blogpost:0,control:0,quickstart:0,give:0,challeng:0,share:0,templat:0,critic:0,tag:0,proprietari:0,explor:0,onlin:0,unfortun:0,occup:0,end:0,goal:0,thing:0,anoth:0,deniabl:0,write:0,how:0,bosh_serv:0,sid:0,expose_rid_and_sid:0,css:0,updat:0,npm:0,regener:0,product:0,resourc:0,after:0,usabl:0,befor:0,allow_contact_request:0,multipl:0,underscor:0,data:0,demonstr:0,man:0,opkod:0,"short":0,attempt:0,practic:0,third:0,seriou:0,secur:0,credenti:0,correspond:0,element:0,caus:0,inform:0,show_only_online_us:0,allow:0,media:0,mechan:0,order:0,talk:0,feedback:0,chatbox:0,xmpp:0,over:0,move:0,becaus:0,telephon:0,through:0,reconnect:0,paramet:0,streamlin:0,snippet:0,jid:0,"8147a27e4a7f9b55ffc85c2683f9529a":0,render:0,fit:0,fix:0,better:0,window:0,pend:0,persist:0,hidden:0,main:0,might:0,them:0,anim:0,"return":0,thei:0,python:0,initi:0,onmessag:0,automat:0,instead:0,front:0,now:0,introduct:0,jump:0,name:0,edit:0,troubleshoot:0,revers:0,crypto:0,authent:0,separ:0,xhr_custom_statu:0,ejabberd:0,each:0,debug:0,side:0,mean:0,everyth:0,domain:0,michael:0,individu:0,idea:0,realli:0,"static":0,connect:0,our:0,happen:0,extract:0,event:0,special:0,out:0,variabl:0,shown:0,"3rd":0,space:0,jabber:0,proxy_pass:0,auto_reconnect:0,content:0,method:0,rel:0,internet:0,got:0,plural:0,factori:0,po2json:0,proxi:0,insid:0,written:0,standard:0,standalon:0,reason:0,put:0,succesfulli:0,afterward:0,xhr_custom_status_url:0,rewriteengin:0,could:0,keep:0,turn:0,perhap:0,imposs:0,first:0,origin:0,softwar:0,directli:0,malici:0,onc:0,hoop:0,lastnam:0,cryptograph:0,number:0,yourself:0,restrict:0,instruct:0,alreadi:0,done:0,submit:0,onchatboxclos:0,owner:0,happi:0,miss:0,suffic:0,differ:0,php:0,script:0,top:0,attack:0,messag:0,attach:0,stori:0,jed:0,privaci:0,"final":0,listen:0,luckili:0,consol:0,option:0,tool:0,specifi:0,part:0,bower:0,exactli:0,than:0,serv:0,wide:0,kind:0,bloat:0,provid:0,remov:0,project:0,bridg:0,bind:0,someothersit:0,browser:0,pre:0,"function":0,sai:0,forward_messag:0,show_controlbox_by_default:0,saa:0,modern:0,ani:0,packag:0,increment:0,tabl:0,need:0,moffitt:0,django:0,bosh_service_url:0,prebind:0,callback:0,latter:0,thorough:0,port:0,note:0,also:0,exampl:0,take:0,which:0,singl:0,sure:0,roster:0,unsur:0,previou:0,reach:0,most:0,eavesdropp:0,homepag:0,onchatboxtoggl:0,don:0,use_vcard:0,url:0,clear:0,request:0,doe:0,runtim:0,determin:0,pars:0,usual:0,xdomainrequest:0,devdepend:0,show:0,german:0,text:0,server_nam:0,session:0,protocol:0,longer:0,fine:0,find:0,help:0,xml:0,current:0,onli:0,grunt:0,locat:0,just:0,configur:0,apach:0,stanza:0,haven:0,busi:0,folder:0,local:0,meant:0,get:0,stop:0,soon:0,repo:0,nativ:0,cannot:0,cryptographi:0,deploy:0,requir:0,show_call_button:[],enabl:0,emb:0,mainspec:0,whenev:0,patch:0,remot:0,bad:0,integr:0,contain:0,jshint:0,where:0,view:0,wiki:0,set:0,habit:0,stroph:0,see:0,bare:0,result:0,close:0,calendar:0,eventnam:0,best:0,concern:0,jqueri:0,statu:0,said:0,extend:0,inconveni:0,someth:0,state:0,muc:0,between:0,awai:0,experi:0,jasmin:0,across:0,attribut:0,verifi:0,appreci:0,kei:0,screen:0,javascript:0,conjunct:0,visible_toolbar_button:0,job:0,entir:0,bosh:0,otherwis:0,"5e64a30272af065bd72258c565a03f2f":0,carbon:0,cache_otr_kei:0,both:0,cor:0,instant:0,shortliv:0,conversej:0,etc:0,grain:0,mani:0,login:0,com:0,load:0,simpli:0,within:0,pot:0,onreconnect:0,solv:0,assum:0,malleabl:0,backend:0,quit:0,enable_message_carbon:0,sucessfulli:0,addition:0,rebuild:0,due:0,been:0,compon:0,json:0,much:0,toolbar:0,subscrib:0,session_kei:0,fire:0,imag:0,xxx:0,rubi:0,convert:0,minifi:0,togeth:0,els:0,i18n:0,otr:0,plausibl:0,present:0,"case":0,multi:0,therefor:0,look:0,servic:0,plugin:0,defin:0,"while":0,abov:0,error:0,howev:0,hightlight:0,have:0,helper:0,demo:0,auto_subscrib:0,non:0,oncallbuttonclick:0,itself:0,incom:0,rid:0,develop:0,harsh:0,open:0,minim:0,receiv:0,parti:0,make:0,secreci:0,minif:0,cross:0,same:0,read:0,onconnectfacebook:0,html:0,unexpectedli:0,chatroom:0,document:0,medit:0,conflict:0,complet:0,signon:0,http:0,webserv:0,optim:0,upon:0,someon:0,hand:0,fairli:0,"50kb":0,user:0,uncaught:0,rewriterul:0,xhr_user_search:0,cssmin:0,recent:0,weibel:0,stateless:0,off:0,bewar:0,firstli:0,markup:0,min:0,well:0,object:0,without:0,thought:0,person:0,contact:0,command:0,wherebi:0,thi:0,choos:0,model:0,latest:0,plural_form:0,identifi:0,execut:0,when:0,onstatuschang:0,xep:0,languag:0,web:0,xmlhttprequest:0,expos:0,field:0,extra:0,had:0,onchatboxopen:0,desktop:0,add:0,other:0,chat:0,non_amd:0,versa:0,primit:0,input:0,match:0,build:0,applic:0,format:0,webpag:0,amd:0,nginx:0,traffic:0,know:0,press:0,xss:0,like:0,specif:0,manual:0,server:0,benefit:0,api:0,either:0,output:0,perfect:0,manag:0,candi:0,facebookconnect:0,right:0,deal:0,nplural:0,some:0,back:0,drop:0,librari:0,bottom:0,avoid:0,though:0,achiev:0,track:0,allow_otr:0,inject:0,overcom:0,oniniti:0,localhost:0,avatar:0,maxim:0,plu:0,who:0,run:0,host:0,although:0,post:0,appli:0,panel:0,src:0,about:0,firstnam:0,controlbox:0,page:0,issu:0,stand:0,act:0,client:0,own:0,curiou:0,deploi:0,encod:0,harm:0,onbuddystatusmessagechang:0,empti:0,onreadi:0,wrap:0,chang:0,storag:0,your:0,merg:0,git:0,log:0,wai:0,pictur:0,aren:0,transfer:0,support:0,"long":0,custom:0,avail:0,trigger:0,includ:0,lot:0,suit:0,forward:0,analysi:0,head:0,properli:0,form:0,bundl:0,somehow:0,link:0,translat:0,synonym:0,line:0,inlin:0,"true":0,bug:0,congratul:0,requirej:0,info:0,pull:0,made:0,dirti:0,locale_data:0,reload:0,whether:0,bugfix:0,displai:[],asynchron:0,record:0,below:0,those:0,toggl:0,legwork:0,problem:0,emit:0,expect:0,onrosterviewupd:0,featur:0,constant:0,creat:0,movim:0,decrypt:0,doesn:0,mode:0,msgmerg:0,exist:0,file:0,face:0,check:0,probabl:0,tab:0,encrypt:0,want:0,onrost:0,pat:0,tip:0,detail:0,gettext:0,"default":0,valid:0,onchatboxfocus:0,rememb:0,varieti:0,test:0,you:0,servernam:0,nice:0,node:0,intend:0,duck:0,onstatusmessagechang:0,org:0,"class":0,releas:0,consid:0,hide_muc_serv:0,stai:0,lang:0,fraught:0,vice:0,directori:0,virtualhost:0,getjson:0,rule:0,allow_muc:0,ignor:0,token:0,potenti:0,time:0},objtypes:{},titles:["Quickstart (to get a demo up and running)"],objnames:{},filenames:["index"]})
\ No newline at end of file
docs/source/index.rst
View file @ 517e6001
......@@ -826,7 +826,7 @@ Configuration variables
allow_contact_requests
----------------------
Default = ``true``
Default: ``true``
Allow users to add one another as contacts. If this is set to false, the
**Add a contact** widget, **Contact Requests** and **Pending Contacts** roster
......@@ -836,22 +836,29 @@ ignored.
allow_muc
---------
Default = ``true``
Default: ``true``
Allow multi-user chat (muc) in chatrooms. Setting this to ``false`` will remove
the ``Chatrooms`` tab from the control box.
allow_muc
---------
Default: ``true``
Allow Off-the-record encryption of single-user chat messages.
animate
-------
Default = ``true``
Default: ``true``
Show animations, for example when opening and closing chat boxes.
auto_list_rooms
---------------
Default = ``false``
Default: ``false``
If true, and the XMPP server on which the current user is logged in supports
multi-user chat, then a list of rooms on that server will be fetched.
......@@ -865,7 +872,7 @@ option will create lots of extra connection traffic.
auto_reconnect
--------------
Default = ``true``
Default: ``true``
Automatically reconnect to the XMPP server if the connection drops
unexpectedly.
......@@ -873,7 +880,7 @@ unexpectedly.
auto_subscribe
--------------
Default = ``false``
Default: ``false``
If true, the user will automatically subscribe back to any contact requests.
......@@ -888,7 +895,7 @@ See `here <http://metajack.im/2008/09/08/which-bosh-server-do-you-need>`_ for mo
cache_otr_key
-------------
Default = ``false``
Default: ``false``
Let the `OTR (Off-the-record encryption) <https://otr.cypherpunks.ca>`_ private
key be cached in your browser's session storage.
......@@ -912,21 +919,21 @@ This setting can only be used together with ``allow_otr = true``.
debug
-----
Default = ``false``
Default: ``false``
If set to true, debugging output will be logged to the browser console.
enable_message_carbons
----------------------
Default = ``false``
Default: ``false``
Support for `XEP-0280: Message Carbons <https://xmpp.org/extensions/xep-0280.html>`_
expose_rid_and_sid
------------------
Default = ``false``
Default: ``false``
Allow the prebind tokens, RID (request ID) and SID (session ID), to be exposed
globally via the API. This allows other scripts served on the same page to use
......@@ -938,7 +945,7 @@ and inject fake chat messages.
forward_messages
----------------
Default = ``false``
Default: ``false``
If set to ``true``, sent messages will also be forwarded to other connected
XMPP resources (e.g. chat clients) of the same user.
......@@ -957,7 +964,7 @@ logged in user, otherwise the user's vCard will be fetched.
hide_muc_server
---------------
Default = ``false``
Default: ``false``
Hide the ``server`` input field of the form inside the ``Room`` panel of the
controlbox. Useful if you want to restrict users to a specific XMPP server of
......@@ -972,7 +979,7 @@ Specify the locale/language. The language must be in the ``locales`` object. Ref
prebind
--------
Default = ``false``
Default: ``false``
Use this option when you want to attach to an existing XMPP connection that was
already authenticated (usually on the backend before page load).
......@@ -992,7 +999,7 @@ Additionally, you have to specify ``bosh_service_url``.
show_controlbox_by_default
--------------------------
Default = ``false``
Default: ``false``
The "controlbox" refers to the special chatbox containing your contacts roster,
status widget, chatrooms and other controls.
......@@ -1003,32 +1010,10 @@ the page with class *toggle-online-users*.
If this options is set to true, the controlbox will by default be shown upon
page load.
show_call_button
----------------
Default = ``false``
Enable to display a call button on the chatbox toolbar.
When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.
::
converse.on('onCallButtonClicked', function(event, data) {
console.log('Call button was clicked.');
console.log('Strophe connection is', data.connection);
console.log('Bare buddy JID is', data.model.get('jid'));
// ... Third-party library code ...
});
show_only_online_users
----------------------
Default = ``false``
Default: ``false``
If set to ``true``, only online users will be shown in the contacts roster.
Users with any other status (e.g. away, busy etc.) will not be shown.
......@@ -1036,7 +1021,7 @@ Users with any other status (e.g. away, busy etc.) will not be shown.
use_otr_by_default
------------------
Default = ``false``
Default: ``false``
If set to ``true``, Converse.js will automatically try to initiate an OTR (off-the-record)
encrypted chat session every time you open a chat box.
......@@ -1044,16 +1029,48 @@ encrypted chat session every time you open a chat box.
use_vcards
----------
Default = ``true``
Default: ``true``
Determines whether the XMPP server will be queried for roster contacts' VCards
or not. VCards contain extra personal information such as your fullname and
avatar image.
visible_toolbar_buttons
-----------------------
Default:
::
{
'emoticons': true,
'call': false,
'clear': true
}
Allows you to show or hide buttons on the chat boxes' toolbars.
* *emoticons*:
Enables rendering of emoticons and provides a toolbar button for choosing them.
* *call*:
Provides a button with a picture of a telephone on it.
When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.
::
converse.on('onCallButtonClicked', function(event, data) {
console.log('Strophe connection is', data.connection);
console.log('Bare buddy JID is', data.model.get('jid'));
// ... Third-party library code ...
});
* *clear*:
Provides a button for clearing messages from a chat box.
xhr_custom_status
-----------------
Default = ``false``
Default: ``false``
.. Note ::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
......@@ -1067,7 +1084,7 @@ xhr_custom_status_url
.. Note ::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Default = Empty string
Default: Empty string
Used only in conjunction with ``xhr_custom_status``.
......@@ -1079,7 +1096,7 @@ The message itself is sent in the request under the key ``msg``.
xhr_user_search
---------------
Default = ``false``
Default: ``false``
.. Note ::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
......@@ -1102,7 +1119,7 @@ xhr_user_search_url
.. Note ::
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
Default = Empty string
Default: Empty string
Used only in conjunction with ``xhr_user_search``.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7