Skip to content

C
converse.js
Commit 481ea9e7 authored by JC Brand's avatar JC Brand
Browse files
Options

Generate HTML docs.

parent f26e709a
Hide whitespace changes
Inline Side-by-side
Showing with 353 additions and 153 deletions
docs/html/.buildinfo
View file @ 481ea9e7
# Sphinx build info version 1 # Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 10e42bcb00305f18f6856c260269639c config: 73b737527a6e49029fd275fb82c0f2ad
tags: 645f666f9bcd5a90fca523b33c5a78b7 tags: 645f666f9bcd5a90fca523b33c5a78b7
docs/html/_sources/index.txt
View file @ 481ea9e7
...@@ -340,6 +340,40 @@ Languages increase the size of the Converse.js significantly. ...@@ -340,6 +340,40 @@ Languages increase the size of the Converse.js significantly.
If you only need one, or a subset of the available languages, it's better to If you only need one, or a subset of the available languages, it's better to
make a custom build which includes only those languages that you need. make a custom build which includes only those languages that you need.
Chat Rooms
==========
Commands
--------
Here are the different commands that may be used in a chat room:
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| Event Type | When is it triggered? | Example (substitue $nickname with an actual user's nickname) |
+============+==============================================================================================+===============================================================+
| **ban** | Ban a user from the chat room. They will not be able to join again. | /ban $nickname |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **clear** | Clear the messages shown in the chat room. | /clear |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **deop** | Make a moderator a normal participant. | /deop $nickname [$reason] |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **help** | Show the list of available commands. | /help |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **kick** | Kick a user out of a room. They will be able to join again. | /kick $nickname [$reason] |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **me** | Speak in the 3rd person. | /me $message |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **mute** | Remove a user's ability to post messages to the room. They will still be able to observe. | /mute $nickname [$reason] |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **nick** | Change your nickname. | /nick $nickname |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **op** | Make a normal participant a moderator. | /op $nickname [$reason] |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **topic** | Set the topic of the chat room. | /topic ${topic text} |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
| **voice** | Allow a muted user to post messages to the room. | /voice $nickname [$reason] |
+------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------+
=========== ===========
Development Development
=========== ===========
...@@ -602,8 +636,8 @@ making sure to also paste the JSON data as value to the "locale_data" key. ...@@ -602,8 +636,8 @@ making sure to also paste the JSON data as value to the "locale_data" key.
.. Note :: .. Note ::
If you are adding translations for a new language that is not already supported, If you are adding translations for a new language that is not already supported,
you'll have to make one more edit in ./locale/locales.js to make sure the you'll have to add the language path in main.js and make one more edit in ./locale/locales.js
language is loaded by require.js. to make sure the language is loaded by require.js.
Congratulations, you've now succesfully added your translations. Sorry for all Congratulations, you've now succesfully added your translations. Sorry for all
those hoops you had to jump through. those hoops you had to jump through.
...@@ -761,6 +795,10 @@ Here are the different events that are emitted: ...@@ -761,6 +795,10 @@ Here are the different events that are emitted:
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **chatBoxToggled** | When a chat box has been minimized or maximized. | ``converse.on('chatBoxToggled', function (chatbox) { ... });`` | | **chatBoxToggled** | When a chat box has been minimized or maximized. | ``converse.on('chatBoxToggled', function (chatbox) { ... });`` |
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **roomInviteSent** | After the user has sent out a direct invitation, to a roster contact, asking them to join a room. | ``converse.on('roomInvite', function (roomview, invitee_jid, reason) { ... });`` |
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **roomInviteReceived** | After the user has sent out a direct invitation, to a roster contact, asking them to join a room. | ``converse.on('roomInvite', function (roomview, invitee_jid, reason) { ... });`` |
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **statusChanged** | When own chat status has changed. | ``converse.on('statusChanged', function (status) { ... });`` | | **statusChanged** | When own chat status has changed. | ``converse.on('statusChanged', function (status) { ... });`` |
+----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +----------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **statusMessageChanged** | When own custom status message has changed. | ``converse.on('statusMessageChanged', function (message) { ... });`` | | **statusMessageChanged** | When own custom status message has changed. | ``converse.on('statusMessageChanged', function (message) { ... });`` |
...@@ -894,13 +932,38 @@ Default: ``false`` ...@@ -894,13 +932,38 @@ Default: ``false``
If set to true, debugging output will be logged to the browser console. If set to true, debugging output will be logged to the browser console.
keepalive
---------
Default: ``true``
Determines whether Converse.js will maintain the chat session across page
loads.
*Please be aware*: This is a new still relatively experimental feature and there might be some
unhandled edge-cases.
message_carbons message_carbons
---------------------- ---------------
Default: ``false`` Default: ``false``
Support for `XEP-0280: Message Carbons <https://xmpp.org/extensions/xep-0280.html>`_ Support for `XEP-0280: Message Carbons <https://xmpp.org/extensions/xep-0280.html>`_
In order to keep all IM clients for a user engaged in a conversation,
outbound messages are carbon-copied to all interested resources.
This is especially important in webchat, like converse.js, where each browser
tab serves as a separate IM client.
Both message_carbons and `forward_messages`_ try to solve the same problem
(showing sent messages in all connected chat clients aka resources), but go about it
in two different ways.
Message carbons is the XEP (Jabber protocol extension) specifically drafted to
solve this problem, while `forwarded_messages`_ uses
`stanza forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_
expose_rid_and_sid expose_rid_and_sid
------------------ ------------------
...@@ -918,13 +981,18 @@ forward_messages ...@@ -918,13 +981,18 @@ forward_messages
Default: ``false`` Default: ``false``
If set to ``true``, sent messages will also be forwarded to other connected If set to ``true``, sent messages will also be forwarded to the sending user's
XMPP resources (e.g. chat clients) of the same user. bare JID (their Jabber ID independent of any chat clients aka resources).
This means that sent messages are visible from all the user's chat clients,
and not just the one from which it was actually sent.
This is useful for example if converse.js is running in multiple tabs of the This is especially important for web chat, such as converse.js, where each
browser and you want sent messages to appear in all of them. browser tab functions as a separate chat client, with its own resource.
See also `XEP 0297: Stanza Forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_ This feature uses Stanza forwarding, see also `XEP 0297: Stanza Forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_
For an alternative approach, see also `message carbons`_.
fullname fullname
-------- --------
...@@ -952,6 +1020,9 @@ play_sounds ...@@ -952,6 +1020,9 @@ play_sounds
Default: ``false`` Default: ``false``
Plays a notification sound when you receive a personal message or when your
nickname is mentioned in a chat room.
Inside the ``./sounds`` directory of the Converse.js repo, you'll see MP3 and Ogg Inside the ``./sounds`` directory of the Converse.js repo, you'll see MP3 and Ogg
formatted sound files. We need both, because neither format is supported by all browsers. formatted sound files. We need both, because neither format is supported by all browsers.
...@@ -1023,7 +1094,7 @@ Default: ``session`` ...@@ -1023,7 +1094,7 @@ Default: ``session``
Valid options: ``session``, ``local``. Valid options: ``session``, ``local``.
This option determines the type of `storage <https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage>`_ This option determines the type of `storage <https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage>`_
(``localStorage`` or ``sessionStorage``) used by converse.js to cache user data. (``localStorage`` or ``sessionStorage``) used by converse.js to cache user data.
Originally converse.js used only localStorage, however sessionStorage is from a Originally converse.js used only localStorage, however sessionStorage is from a
...@@ -1035,6 +1106,16 @@ it's closed, the data is cleared. ...@@ -1035,6 +1106,16 @@ it's closed, the data is cleared.
Data in localStorage on the other hand is kept indefinitely. Data in localStorage on the other hand is kept indefinitely.
.. Note ::
Since version 0.8.0, the use of local storage is not recommended. The
statuses (online, away, busy etc.) of your roster contacts are cached in
the browser storage. If you use local storage, these values are stored for
multiple sessions, and they will likely become out of sync with your contacts'
actual statuses. The session storage doesn't have this problem, because
roster contact statuses will not become out of sync in a single session,
only across more than one session.
use_otr_by_default use_otr_by_default
------------------ ------------------
...@@ -1060,29 +1141,29 @@ Default: ...@@ -1060,29 +1141,29 @@ Default:
:: ::
{ {
'emoticons': true, call: false,
'call': false, clear: true,
'clear': true emoticons: true,
toggle_participants: true
} }
Allows you to show or hide buttons on the chat boxes' toolbars. Allows you to show or hide buttons on the chat boxes' toolbars.
* *emoticons*: * *call*:
Enables rendering of emoticons and provides a toolbar button for choosing them.
* *call*:
Provides a button with a picture of a telephone on it. 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. 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('callButtonClicked', function(event, data) { converse.on('callButtonClicked', function(event, data) {
console.log('Strophe connection is', data.connection); console.log('Strophe connection is', data.connection);
console.log('Bare buddy JID is', data.model.get('jid')); console.log('Bare buddy JID is', data.model.get('jid'));
// ... Third-party library code ... // ... Third-party library code ...
}); });
* *clear*: * *clear*:
Provides a button for clearing messages from a chat box. Provides a button for clearing messages from a chat box.
* *emoticons*:
Enables rendering of emoticons and provides a toolbar button for choosing them.
* toggle_participants:
Shows a button for toggling (i.e. showing/hiding) the list of participants in a chat room.
xhr_custom_status xhr_custom_status
----------------- -----------------
......
docs/html/genindex.html
View file @ 481ea9e7
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; Converse.js 0.8.0 documentation</title> <title>Index &mdash; Converse.js 0.8.1 documentation</title>
<link rel="stylesheet" href="_static/stylesheet.css" type="text/css" /> <link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT: './', URL_ROOT: './',
VERSION: '0.8.0', VERSION: '0.8.1',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html', FILE_SUFFIX: '.html',
HAS_SOURCE: true HAS_SOURCE: true
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Converse.js 0.8.0 documentation" href="index.html" /> <link rel="top" title="Converse.js 0.8.1 documentation" href="index.html" />
</head> </head>
<body> <body>
<div id="header_wrap" class="outer"> <div id="header_wrap" class="outer">
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
<li class="right" style="margin-right: 10px"> <li class="right" style="margin-right: 10px">
<a href="#" title="General Index" <a href="#" title="General Index"
accesskey="I">index</a></li> accesskey="I">index</a></li>
<li><a href="index.html">Converse.js 0.8.0 documentation</a> &raquo;</li> <li><a href="index.html">Converse.js 0.8.1 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
<section id="main_content" class="inner"> <section id="main_content" class="inner">
...@@ -71,7 +71,7 @@ ...@@ -71,7 +71,7 @@
<li class="right" style="margin-right: 10px"> <li class="right" style="margin-right: 10px">
<a href="#" title="General Index" <a href="#" title="General Index"
>index</a></li> >index</a></li>
<li><a href="index.html">Converse.js 0.8.0 documentation</a> &raquo;</li> <li><a href="index.html">Converse.js 0.8.1 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
</div> </div>
......
docs/html/index.html
View file @ 481ea9e7
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Quickstart (to get a demo up and running) &mdash; Converse.js 0.8.0 documentation</title> <title>Quickstart (to get a demo up and running) &mdash; Converse.js 0.8.1 documentation</title>
<link rel="stylesheet" href="_static/stylesheet.css" type="text/css" /> <link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT: './', URL_ROOT: './',
VERSION: '0.8.0', VERSION: '0.8.1',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html', FILE_SUFFIX: '.html',
HAS_SOURCE: true HAS_SOURCE: true
...@@ -23,7 +23,7 @@ ...@@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Converse.js 0.8.0 documentation" href="#" /> <link rel="top" title="Converse.js 0.8.1 documentation" href="#" />
</head> </head>
<body> <body>
<div id="header_wrap" class="outer"> <div id="header_wrap" class="outer">
...@@ -41,7 +41,7 @@ ...@@ -41,7 +41,7 @@
<li class="right" style="margin-right: 10px"> <li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index" <a href="genindex.html" title="General Index"
accesskey="I">index</a></li> accesskey="I">index</a></li>
<li><a href="#">Converse.js 0.8.0 documentation</a> &raquo;</li> <li><a href="#">Converse.js 0.8.1 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
<section id="main_content" class="inner"> <section id="main_content" class="inner">
...@@ -76,69 +76,74 @@ ...@@ -76,69 +76,74 @@
<li><a class="reference internal" href="#off-the-record-encryption" id="id17">Off-the-record encryption</a></li> <li><a class="reference internal" href="#off-the-record-encryption" id="id17">Off-the-record encryption</a></li>
<li><a class="reference internal" href="#sound-notifications" id="id18">Sound Notifications</a></li> <li><a class="reference internal" href="#sound-notifications" id="id18">Sound Notifications</a></li>
<li><a class="reference internal" href="#multilingual-support" id="id19">Multilingual Support</a></li> <li><a class="reference internal" href="#multilingual-support" id="id19">Multilingual Support</a></li>
<li><a class="reference internal" href="#chat-rooms" id="id20">Chat Rooms</a><ul>
<li><a class="reference internal" href="#commands" id="id21">Commands</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#development" id="id20">Development</a><ul>
<li><a class="reference internal" href="#install-the-development-and-front-end-dependencies" id="id21">Install the development and front-end dependencies</a></li>
<li><a class="reference internal" href="#with-amd-and-require-js-recommended" id="id22">With AMD and require.js (recommended)</a></li>
<li><a class="reference internal" href="#without-amd-and-require-js" id="id23">Without AMD and require.js</a></li>
<li><a class="reference internal" href="#before-submitting-a-pull-request" id="id24">Before submitting a pull request</a><ul>
<li><a class="reference internal" href="#add-tests-for-your-bugfix-or-feature" id="id25">Add tests for your bugfix or feature</a></li>
<li><a class="reference internal" href="#check-that-the-tests-pass" id="id26">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="id27">Check your code for errors or bad habits by running JSHint</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#minification" id="id28">Minification</a><ul> <li><a class="reference internal" href="#development" id="id22">Development</a><ul>
<li><a class="reference internal" href="#minifying-javascript-and-css" id="id29">Minifying Javascript and CSS</a></li> <li><a class="reference internal" href="#install-the-development-and-front-end-dependencies" id="id23">Install the development and front-end dependencies</a></li>
<li><a class="reference internal" href="#with-amd-and-require-js-recommended" id="id24">With AMD and require.js (recommended)</a></li>
<li><a class="reference internal" href="#without-amd-and-require-js" id="id25">Without AMD and require.js</a></li>
<li><a class="reference internal" href="#before-submitting-a-pull-request" id="id26">Before submitting a pull request</a><ul>
<li><a class="reference internal" href="#add-tests-for-your-bugfix-or-feature" id="id27">Add tests for your bugfix or feature</a></li>
<li><a class="reference internal" href="#check-that-the-tests-pass" id="id28">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="id29">Check your code for errors or bad habits by running JSHint</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#translations" id="id30">Translations</a></li> <li><a class="reference internal" href="#minification" id="id30">Minification</a><ul>
<li><a class="reference internal" href="#minifying-javascript-and-css" id="id31">Minifying Javascript and CSS</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#troubleshooting" id="id31">Troubleshooting</a><ul> <li><a class="reference internal" href="#translations" id="id32">Translations</a></li>
<li><a class="reference internal" href="#conflicts-with-other-javascript-libraries" id="id32">Conflicts with other Javascript libraries</a><ul>
<li><a class="reference internal" href="#problem" id="id33">Problem:</a></li>
<li><a class="reference internal" href="#solution" id="id34">Solution:</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#troubleshooting" id="id33">Troubleshooting</a><ul>
<li><a class="reference internal" href="#conflicts-with-other-javascript-libraries" id="id34">Conflicts with other Javascript libraries</a><ul>
<li><a class="reference internal" href="#problem" id="id35">Problem:</a></li>
<li><a class="reference internal" href="#solution" id="id36">Solution:</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#events" id="id35">Events</a><ul>
<li><a class="reference internal" href="#event-methods" id="id36">Event Methods</a></li>
<li><a class="reference internal" href="#event-types" id="id37">Event Types</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#configuration" id="id38">Configuration</a><ul> <li><a class="reference internal" href="#events" id="id37">Events</a><ul>
<li><a class="reference internal" href="#configuration-variables" id="id39">Configuration variables</a><ul> <li><a class="reference internal" href="#event-methods" id="id38">Event Methods</a></li>
<li><a class="reference internal" href="#allow-contact-requests" id="id40">allow_contact_requests</a></li> <li><a class="reference internal" href="#event-types" id="id39">Event Types</a></li>
<li><a class="reference internal" href="#allow-muc" id="id41">allow_muc</a></li> </ul>
<li><a class="reference internal" href="#id3" id="id42">allow_muc</a></li> </li>
<li><a class="reference internal" href="#animate" id="id43">animate</a></li> <li><a class="reference internal" href="#configuration" id="id40">Configuration</a><ul>
<li><a class="reference internal" href="#auto-list-rooms" id="id44">auto_list_rooms</a></li> <li><a class="reference internal" href="#configuration-variables" id="id41">Configuration variables</a><ul>
<li><a class="reference internal" href="#auto-reconnect" id="id45">auto_reconnect</a></li> <li><a class="reference internal" href="#allow-contact-requests" id="id42">allow_contact_requests</a></li>
<li><a class="reference internal" href="#auto-subscribe" id="id46">auto_subscribe</a></li> <li><a class="reference internal" href="#allow-muc" id="id43">allow_muc</a></li>
<li><a class="reference internal" href="#bosh-service-url" id="id47">bosh_service_url</a></li> <li><a class="reference internal" href="#id3" id="id44">allow_muc</a></li>
<li><a class="reference internal" href="#cache-otr-key" id="id48">cache_otr_key</a></li> <li><a class="reference internal" href="#animate" id="id45">animate</a></li>
<li><a class="reference internal" href="#debug" id="id49">debug</a></li> <li><a class="reference internal" href="#auto-list-rooms" id="id46">auto_list_rooms</a></li>
<li><a class="reference internal" href="#message-carbons" id="id50">message_carbons</a></li> <li><a class="reference internal" href="#auto-reconnect" id="id47">auto_reconnect</a></li>
<li><a class="reference internal" href="#expose-rid-and-sid" id="id51">expose_rid_and_sid</a></li> <li><a class="reference internal" href="#auto-subscribe" id="id48">auto_subscribe</a></li>
<li><a class="reference internal" href="#forward-messages" id="id52">forward_messages</a></li> <li><a class="reference internal" href="#bosh-service-url" id="id49">bosh_service_url</a></li>
<li><a class="reference internal" href="#fullname" id="id53">fullname</a></li> <li><a class="reference internal" href="#cache-otr-key" id="id50">cache_otr_key</a></li>
<li><a class="reference internal" href="#hide-muc-server" id="id54">hide_muc_server</a></li> <li><a class="reference internal" href="#debug" id="id51">debug</a></li>
<li><a class="reference internal" href="#i18n" id="id55">i18n</a></li> <li><a class="reference internal" href="#keepalive" id="id52">keepalive</a></li>
<li><a class="reference internal" href="#play-sounds" id="id56">play_sounds</a></li> <li><a class="reference internal" href="#message-carbons" id="id53">message_carbons</a></li>
<li><a class="reference internal" href="#prebind" id="id57">prebind</a></li> <li><a class="reference internal" href="#expose-rid-and-sid" id="id54">expose_rid_and_sid</a></li>
<li><a class="reference internal" href="#roster-groups" id="id58">roster_groups</a></li> <li><a class="reference internal" href="#forward-messages" id="id55">forward_messages</a></li>
<li><a class="reference internal" href="#show-controlbox-by-default" id="id59">show_controlbox_by_default</a></li> <li><a class="reference internal" href="#fullname" id="id56">fullname</a></li>
<li><a class="reference internal" href="#show-only-online-users" id="id60">show_only_online_users</a></li> <li><a class="reference internal" href="#hide-muc-server" id="id57">hide_muc_server</a></li>
<li><a class="reference internal" href="#storage" id="id61">storage</a></li> <li><a class="reference internal" href="#i18n" id="id58">i18n</a></li>
<li><a class="reference internal" href="#use-otr-by-default" id="id62">use_otr_by_default</a></li> <li><a class="reference internal" href="#play-sounds" id="id59">play_sounds</a></li>
<li><a class="reference internal" href="#use-vcards" id="id63">use_vcards</a></li> <li><a class="reference internal" href="#prebind" id="id60">prebind</a></li>
<li><a class="reference internal" href="#visible-toolbar-buttons" id="id64">visible_toolbar_buttons</a></li> <li><a class="reference internal" href="#roster-groups" id="id61">roster_groups</a></li>
<li><a class="reference internal" href="#xhr-custom-status" id="id65">xhr_custom_status</a></li> <li><a class="reference internal" href="#show-controlbox-by-default" id="id62">show_controlbox_by_default</a></li>
<li><a class="reference internal" href="#xhr-custom-status-url" id="id66">xhr_custom_status_url</a></li> <li><a class="reference internal" href="#show-only-online-users" id="id63">show_only_online_users</a></li>
<li><a class="reference internal" href="#xhr-user-search" id="id67">xhr_user_search</a></li> <li><a class="reference internal" href="#storage" id="id64">storage</a></li>
<li><a class="reference internal" href="#xhr-user-search-url" id="id68">xhr_user_search_url</a></li> <li><a class="reference internal" href="#use-otr-by-default" id="id65">use_otr_by_default</a></li>
<li><a class="reference internal" href="#use-vcards" id="id66">use_vcards</a></li>
<li><a class="reference internal" href="#visible-toolbar-buttons" id="id67">visible_toolbar_buttons</a></li>
<li><a class="reference internal" href="#xhr-custom-status" id="id68">xhr_custom_status</a></li>
<li><a class="reference internal" href="#xhr-custom-status-url" id="id69">xhr_custom_status_url</a></li>
<li><a class="reference internal" href="#xhr-user-search" id="id70">xhr_user_search</a></li>
<li><a class="reference internal" href="#xhr-user-search-url" id="id71">xhr_user_search_url</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
...@@ -409,15 +414,81 @@ message.</p> ...@@ -409,15 +414,81 @@ message.</p>
<p>If you only need one, or a subset of the available languages, it&#8217;s better to <p>If you only need one, or a subset of the available languages, it&#8217;s better to
make a custom build which includes only those languages that you need.</p> make a custom build which includes only those languages that you need.</p>
</div> </div>
<div class="section" id="chat-rooms">
<h2><a class="toc-backref" href="#id20">Chat Rooms</a><a class="headerlink" href="#chat-rooms" title="Permalink to this headline"></a></h2>
<div class="section" id="commands">
<h3><a class="toc-backref" href="#id21">Commands</a><a class="headerlink" href="#commands" title="Permalink to this headline"></a></h3>
<p>Here are the different commands that may be used in a chat room:</p>
<table border="1" class="docutils">
<colgroup>
<col width="7%" />
<col width="56%" />
<col width="37%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Event Type</th>
<th class="head">When is it triggered?</th>
<th class="head">Example (substitue $nickname with an actual user&#8217;s nickname)</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><strong>ban</strong></td>
<td>Ban a user from the chat room. They will not be able to join again.</td>
<td>/ban $nickname</td>
</tr>
<tr class="row-odd"><td><strong>clear</strong></td>
<td>Clear the messages shown in the chat room.</td>
<td>/clear</td>
</tr>
<tr class="row-even"><td><strong>deop</strong></td>
<td>Make a moderator a normal participant.</td>
<td>/deop $nickname [$reason]</td>
</tr>
<tr class="row-odd"><td><strong>help</strong></td>
<td>Show the list of available commands.</td>
<td>/help</td>
</tr>
<tr class="row-even"><td><strong>kick</strong></td>
<td>Kick a user out of a room. They will be able to join again.</td>
<td>/kick $nickname [$reason]</td>
</tr>
<tr class="row-odd"><td><strong>me</strong></td>
<td>Speak in the 3rd person.</td>
<td>/me $message</td>
</tr>
<tr class="row-even"><td><strong>mute</strong></td>
<td>Remove a user&#8217;s ability to post messages to the room. They will still be able to observe.</td>
<td>/mute $nickname [$reason]</td>
</tr>
<tr class="row-odd"><td><strong>nick</strong></td>
<td>Change your nickname.</td>
<td>/nick $nickname</td>
</tr>
<tr class="row-even"><td><strong>op</strong></td>
<td>Make a normal participant a moderator.</td>
<td>/op $nickname [$reason]</td>
</tr>
<tr class="row-odd"><td><strong>topic</strong></td>
<td>Set the topic of the chat room.</td>
<td>/topic ${topic text}</td>
</tr>
<tr class="row-even"><td><strong>voice</strong></td>
<td>Allow a muted user to post messages to the room.</td>
<td>/voice $nickname [$reason]</td>
</tr>
</tbody>
</table>
</div>
</div>
</div> </div>
<div class="section" id="development"> <div class="section" id="development">
<h1><a class="toc-backref" href="#id20">Development</a><a class="headerlink" href="#development" title="Permalink to this headline"></a></h1> <h1><a class="toc-backref" href="#id22">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 <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 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 follow the instructions below to create this folder and fetch Converse&#8217;s
3rd-party dependencies.</p> 3rd-party dependencies.</p>
<div class="section" id="install-the-development-and-front-end-dependencies"> <div class="section" id="install-the-development-and-front-end-dependencies">
<h2><a class="toc-backref" href="#id21">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="#id23">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>) <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> 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 <p>If you don&#8217;t have Node.js installed, you can download and install the latest
...@@ -456,7 +527,7 @@ Converse.js directly depends and which will be loaded in the browser.</p> ...@@ -456,7 +527,7 @@ Converse.js directly depends and which will be loaded in the browser.</p>
</ul> </ul>
</div> </div>
<div class="section" id="with-amd-and-require-js-recommended"> <div class="section" id="with-amd-and-require-js-recommended">
<h2><a class="toc-backref" href="#id22">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="#id24">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>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 <p>If you want to develop or customize converse.js, you&#8217;ll want to load the
non-minified javascript files.</p> non-minified javascript files.</p>
...@@ -470,7 +541,7 @@ attribute on the <em>script</em> tag), which will in turn cause converse.js to b ...@@ -470,7 +541,7 @@ attribute on the <em>script</em> tag), which will in turn cause converse.js to b
parsed.</p> parsed.</p>
</div> </div>
<div class="section" id="without-amd-and-require-js"> <div class="section" id="without-amd-and-require-js">
<h2><a class="toc-backref" href="#id23">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="#id25">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 <p>Converse.js can also be used without require.js. If you for some reason prefer
to use it this way, please refer to 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> <a class="reference external" href="https://github.com/jcbrand/converse.js/blob/master/non_amd.html">non_amd.html</a>
...@@ -478,9 +549,9 @@ for an example of how and in what order all the Javascript files that converse.j ...@@ -478,9 +549,9 @@ for an example of how and in what order all the Javascript files that converse.j
depends on need to be loaded.</p> depends on need to be loaded.</p>
</div> </div>
<div class="section" id="before-submitting-a-pull-request"> <div class="section" id="before-submitting-a-pull-request">
<h2><a class="toc-backref" href="#id24">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="#id26">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"> <div class="section" id="add-tests-for-your-bugfix-or-feature">
<h3><a class="toc-backref" href="#id25">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="#id27">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 <p>Add a test for any bug fixed or feature added. We use Jasmine
for testing.</p> 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 <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
...@@ -489,7 +560,7 @@ the tests are implemented.</p> ...@@ -489,7 +560,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> <a class="reference external" href="http://opkode.com/contact">contact me</a> and I&#8217;ll be happy to help.</p>
</div> </div>
<div class="section" id="check-that-the-tests-pass"> <div class="section" id="check-that-the-tests-pass">
<h3><a class="toc-backref" href="#id26">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="#id28">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 <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> <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> in your browser, and the tests will run automatically.</p>
...@@ -499,7 +570,7 @@ in your browser, and the tests will run automatically.</p> ...@@ -499,7 +570,7 @@ in your browser, and the tests will run automatically.</p>
</div> </div>
</div> </div>
<div class="section" id="check-your-code-for-errors-or-bad-habits-by-running-jshint"> <div class="section" id="check-your-code-for-errors-or-bad-habits-by-running-jshint">
<h3><a class="toc-backref" href="#id27">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="#id29">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 <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> and/or bad habits.</p>
<div class="highlight-python"><div class="highlight"><pre>grunt jshint <div class="highlight-python"><div class="highlight"><pre>grunt jshint
...@@ -512,9 +583,9 @@ and/or bad habits.</p> ...@@ -512,9 +583,9 @@ and/or bad habits.</p>
</div> </div>
</div> </div>
<div class="section" id="minification"> <div class="section" id="minification">
<h2><a class="toc-backref" href="#id28">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline"></a></h2> <h2><a class="toc-backref" href="#id30">Minification</a><a class="headerlink" href="#minification" title="Permalink to this headline"></a></h2>
<div class="section" id="minifying-javascript-and-css"> <div class="section" id="minifying-javascript-and-css">
<h3><a class="toc-backref" href="#id29">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="#id31">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 <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> 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> and then <tt class="docutils literal"><span class="pre">grunt</span> <span class="pre">fetch</span></tt>).</p>
...@@ -532,7 +603,7 @@ using <a class="reference external" href="https://github.com/jrburke/almond">alm ...@@ -532,7 +603,7 @@ using <a class="reference external" href="https://github.com/jrburke/almond">alm
</div> </div>
</div> </div>
<div class="section" id="translations"> <div class="section" id="translations">
<h2><a class="toc-backref" href="#id30">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline"></a></h2> <h2><a class="toc-backref" href="#id32">Translations</a><a class="headerlink" href="#translations" title="Permalink to this headline"></a></h2>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
<p class="last">Translations take up a lot of space and will bloat your minified file. <p class="last">Translations take up a lot of space and will bloat your minified file.
...@@ -607,19 +678,19 @@ create or update the file ./locale/LC_MESSAGES/de.js with the following code:</p ...@@ -607,19 +678,19 @@ create or update the file ./locale/LC_MESSAGES/de.js with the following code:</p
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
<p class="last">If you are adding translations for a new language that is not already supported, <p class="last">If you are adding translations for a new language that is not already supported,
you&#8217;ll have to make one more edit in ./locale/locales.js to make sure the you&#8217;ll have to add the language path in main.js and make one more edit in ./locale/locales.js
language is loaded by require.js.</p> to make sure the language is loaded by require.js.</p>
</div> </div>
<p>Congratulations, you&#8217;ve now succesfully added your translations. Sorry for all <p>Congratulations, you&#8217;ve now succesfully added your translations. Sorry for all
those hoops you had to jump through.</p> those hoops you had to jump through.</p>
</div> </div>
</div> </div>
<div class="section" id="troubleshooting"> <div class="section" id="troubleshooting">
<h1><a class="toc-backref" href="#id31">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline"></a></h1> <h1><a class="toc-backref" href="#id33">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline"></a></h1>
<div class="section" id="conflicts-with-other-javascript-libraries"> <div class="section" id="conflicts-with-other-javascript-libraries">
<h2><a class="toc-backref" href="#id32">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="#id34">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"> <div class="section" id="problem">
<h3><a class="toc-backref" href="#id33">Problem:</a><a class="headerlink" href="#problem" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id35">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 <p>You are using other Javascript libraries (like JQuery plugins), and
get errors like these in your browser console:</p> get errors like these in your browser console:</p>
<div class="highlight-python"><div class="highlight"><pre>Uncaught TypeError: Object [object Object] has no method &#39;xxx&#39; from example.js <div class="highlight-python"><div class="highlight"><pre>Uncaught TypeError: Object [object Object] has no method &#39;xxx&#39; from example.js
...@@ -627,7 +698,7 @@ get errors like these in your browser console:</p> ...@@ -627,7 +698,7 @@ get errors like these in your browser console:</p>
</div> </div>
</div> </div>
<div class="section" id="solution"> <div class="section" id="solution">
<h3><a class="toc-backref" href="#id34">Solution:</a><a class="headerlink" href="#solution" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id36">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>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>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 <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
...@@ -669,11 +740,11 @@ jQuery plugins must load after jQuery).</p> ...@@ -669,11 +740,11 @@ jQuery plugins must load after jQuery).</p>
</div> </div>
</div> </div>
<div class="section" id="events"> <div class="section" id="events">
<h1><a class="toc-backref" href="#id35">Events</a><a class="headerlink" href="#events" title="Permalink to this headline"></a></h1> <h1><a class="toc-backref" href="#id37">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>Converse.js emits events to which you can subscribe from your own Javascript.</p>
<p>Concerning events, the following methods are available:</p> <p>Concerning events, the following methods are available:</p>
<div class="section" id="event-methods"> <div class="section" id="event-methods">
<h2><a class="toc-backref" href="#id36">Event Methods</a><a class="headerlink" href="#event-methods" title="Permalink to this headline"></a></h2> <h2><a class="toc-backref" href="#id38">Event Methods</a><a class="headerlink" href="#event-methods" title="Permalink to this headline"></a></h2>
<ul> <ul>
<li><p class="first"><strong>on(eventName, callback)</strong>:</p> <li><p class="first"><strong>on(eventName, callback)</strong>:</p>
<blockquote> <blockquote>
...@@ -719,7 +790,7 @@ exactly once.</p> ...@@ -719,7 +790,7 @@ exactly once.</p>
</ul> </ul>
</div> </div>
<div class="section" id="event-types"> <div class="section" id="event-types">
<h2><a class="toc-backref" href="#id37">Event Types</a><a class="headerlink" href="#event-types" title="Permalink to this headline"></a></h2> <h2><a class="toc-backref" href="#id39">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> <p>Here are the different events that are emitted:</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
...@@ -782,6 +853,14 @@ exactly once.</p> ...@@ -782,6 +853,14 @@ exactly once.</p>
<td>When a chat box has been minimized or maximized.</td> <td>When a chat box has been minimized or maximized.</td>
<td><tt class="docutils literal"><span class="pre">converse.on('chatBoxToggled',</span> <span class="pre">function</span> <span class="pre">(chatbox)</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">});</span></tt></td> <td><tt class="docutils literal"><span class="pre">converse.on('chatBoxToggled',</span> <span class="pre">function</span> <span class="pre">(chatbox)</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">});</span></tt></td>
</tr> </tr>
<tr class="row-even"><td><strong>roomInviteSent</strong></td>
<td>After the user has sent out a direct invitation, to a roster contact, asking them to join a room.</td>
<td><tt class="docutils literal"><span class="pre">converse.on('roomInvite',</span> <span class="pre">function</span> <span class="pre">(roomview,</span> <span class="pre">invitee_jid,</span> <span class="pre">reason)</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">});</span></tt></td>
</tr>
<tr class="row-odd"><td><strong>roomInviteReceived</strong></td>
<td>After the user has sent out a direct invitation, to a roster contact, asking them to join a room.</td>
<td><tt class="docutils literal"><span class="pre">converse.on('roomInvite',</span> <span class="pre">function</span> <span class="pre">(roomview,</span> <span class="pre">invitee_jid,</span> <span class="pre">reason)</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">});</span></tt></td>
</tr>
<tr class="row-even"><td><strong>statusChanged</strong></td> <tr class="row-even"><td><strong>statusChanged</strong></td>
<td>When own chat status has changed.</td> <td>When own chat status has changed.</td>
<td><tt class="docutils literal"><span class="pre">converse.on('statusChanged',</span> <span class="pre">function</span> <span class="pre">(status)</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">});</span></tt></td> <td><tt class="docutils literal"><span class="pre">converse.on('statusChanged',</span> <span class="pre">function</span> <span class="pre">(status)</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">});</span></tt></td>
...@@ -803,7 +882,7 @@ exactly once.</p> ...@@ -803,7 +882,7 @@ exactly once.</p>
</div> </div>
</div> </div>
<div class="section" id="configuration"> <div class="section" id="configuration">
<h1><a class="toc-backref" href="#id38">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1> <h1><a class="toc-backref" href="#id40">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 <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 you&#8217;ll want to configure <em>Converse.js</em> to suit your needs before you deploy it
on your website.</p> on your website.</p>
...@@ -817,9 +896,9 @@ all the available configuration settings.</p> ...@@ -817,9 +896,9 @@ all the available configuration settings.</p>
JS file so that it will include the new settings. Please refer to the 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> <a class="reference internal" href="#minification">Minification</a> section for more info on how to do this.</p>
<div class="section" id="configuration-variables"> <div class="section" id="configuration-variables">
<h2><a class="toc-backref" href="#id39">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline"></a></h2> <h2><a class="toc-backref" href="#id41">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline"></a></h2>
<div class="section" id="allow-contact-requests"> <div class="section" id="allow-contact-requests">
<h3><a class="toc-backref" href="#id40">allow_contact_requests</a><a class="headerlink" href="#allow-contact-requests" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id42">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>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 <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 <strong>Add a contact</strong> widget, <strong>Contact Requests</strong> and <strong>Pending Contacts</strong> roster
...@@ -827,23 +906,23 @@ sections will all not appear. Additionally, all incoming contact requests will b ...@@ -827,23 +906,23 @@ sections will all not appear. Additionally, all incoming contact requests will b
ignored.</p> ignored.</p>
</div> </div>
<div class="section" id="allow-muc"> <div class="section" id="allow-muc">
<h3><a class="toc-backref" href="#id41">allow_muc</a><a class="headerlink" href="#allow-muc" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id43">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>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 <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> the <tt class="docutils literal"><span class="pre">Chatrooms</span></tt> tab from the control box.</p>
</div> </div>
<div class="section" id="id3"> <div class="section" id="id3">
<h3><a class="toc-backref" href="#id42">allow_muc</a><a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id44">allow_muc</a><a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p> <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> <p>Allow Off-the-record encryption of single-user chat messages.</p>
</div> </div>
<div class="section" id="animate"> <div class="section" id="animate">
<h3><a class="toc-backref" href="#id43">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id45">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>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
<p>Show animations, for example when opening and closing chat boxes.</p> <p>Show animations, for example when opening and closing chat boxes.</p>
</div> </div>
<div class="section" id="auto-list-rooms"> <div class="section" id="auto-list-rooms">
<h3><a class="toc-backref" href="#id44">auto_list_rooms</a><a class="headerlink" href="#auto-list-rooms" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id46">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>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 <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> multi-user chat, then a list of rooms on that server will be fetched.</p>
...@@ -853,24 +932,24 @@ features, number of occupants etc.), so on servers with many rooms this ...@@ -853,24 +932,24 @@ features, number of occupants etc.), so on servers with many rooms this
option will create lots of extra connection traffic.</p> option will create lots of extra connection traffic.</p>
</div> </div>
<div class="section" id="auto-reconnect"> <div class="section" id="auto-reconnect">
<h3><a class="toc-backref" href="#id45">auto_reconnect</a><a class="headerlink" href="#auto-reconnect" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id47">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>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
<p>Automatically reconnect to the XMPP server if the connection drops <p>Automatically reconnect to the XMPP server if the connection drops
unexpectedly.</p> unexpectedly.</p>
</div> </div>
<div class="section" id="auto-subscribe"> <div class="section" id="auto-subscribe">
<h3><a class="toc-backref" href="#id46">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id48">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>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> <p>If true, the user will automatically subscribe back to any contact requests.</p>
</div> </div>
<div class="section" id="bosh-service-url"> <div class="section" id="bosh-service-url">
<h3><a class="toc-backref" href="#id47">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id49">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 <p>Connections to an XMPP server depend on a BOSH connection manager which acts as
a middle man between HTTP and XMPP.</p> 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> <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>
<div class="section" id="cache-otr-key"> <div class="section" id="cache-otr-key">
<h3><a class="toc-backref" href="#id48">cache_otr_key</a><a class="headerlink" href="#cache-otr-key" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id50">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>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 <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> key be cached in your browser&#8217;s session storage.</p>
...@@ -889,17 +968,35 @@ current session. Previous sessions however cannot be decrypted.</p> ...@@ -889,17 +968,35 @@ current session. Previous sessions however cannot be decrypted.</p>
</div> </div>
</div> </div>
<div class="section" id="debug"> <div class="section" id="debug">
<h3><a class="toc-backref" href="#id49">debug</a><a class="headerlink" href="#debug" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id51">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>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> <p>If set to true, debugging output will be logged to the browser console.</p>
</div> </div>
<div class="section" id="keepalive">
<h3><a class="toc-backref" href="#id52">keepalive</a><a class="headerlink" href="#keepalive" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
<p>Determines whether Converse.js will maintain the chat session across page
loads.</p>
<p><em>Please be aware</em>: This is a new still relatively experimental feature and there might be some
unhandled edge-cases.</p>
</div>
<div class="section" id="message-carbons"> <div class="section" id="message-carbons">
<h3><a class="toc-backref" href="#id50">message_carbons</a><a class="headerlink" href="#message-carbons" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id53">message_carbons</a><a class="headerlink" href="#message-carbons" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p> <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> <p>Support for <a class="reference external" href="https://xmpp.org/extensions/xep-0280.html">XEP-0280: Message Carbons</a></p>
<p>In order to keep all IM clients for a user engaged in a conversation,
outbound messages are carbon-copied to all interested resources.</p>
<p>This is especially important in webchat, like converse.js, where each browser
tab serves as a separate IM client.</p>
<p>Both message_carbons and <a class="reference internal" href="#forward-messages">forward_messages</a> try to solve the same problem
(showing sent messages in all connected chat clients aka resources), but go about it
in two different ways.</p>
<p>Message carbons is the XEP (Jabber protocol extension) specifically drafted to
solve this problem, while <a href="#id72"><span class="problematic" id="id73">`forwarded_messages`_</span></a> uses
<a class="reference external" href="http://www.xmpp.org/extensions/xep-0297.html">stanza forwarding</a></p>
</div> </div>
<div class="section" id="expose-rid-and-sid"> <div class="section" id="expose-rid-and-sid">
<h3><a class="toc-backref" href="#id51">expose_rid_and_sid</a><a class="headerlink" href="#expose-rid-and-sid" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id54">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>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 <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 globally via the API. This allows other scripts served on the same page to use
...@@ -908,34 +1005,39 @@ these values.</p> ...@@ -908,34 +1005,39 @@ these values.</p>
and inject fake chat messages.</p> and inject fake chat messages.</p>
</div> </div>
<div class="section" id="forward-messages"> <div class="section" id="forward-messages">
<h3><a class="toc-backref" href="#id52">forward_messages</a><a class="headerlink" href="#forward-messages" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id55">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>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 <p>If set to <tt class="docutils literal"><span class="pre">true</span></tt>, sent messages will also be forwarded to the sending user&#8217;s
XMPP resources (e.g. chat clients) of the same user.</p> bare JID (their Jabber ID independent of any chat clients aka resources).</p>
<p>This is useful for example if converse.js is running in multiple tabs of the <p>This means that sent messages are visible from all the user&#8217;s chat clients,
browser and you want sent messages to appear in all of them.</p> and not just the one from which it was actually sent.</p>
<p>See also <a class="reference external" href="http://www.xmpp.org/extensions/xep-0297.html">XEP 0297: Stanza Forwarding</a></p> <p>This is especially important for web chat, such as converse.js, where each
browser tab functions as a separate chat client, with its own resource.</p>
<p>This feature uses Stanza forwarding, see also <a class="reference external" href="http://www.xmpp.org/extensions/xep-0297.html">XEP 0297: Stanza Forwarding</a></p>
<p>For an alternative approach, see also <a href="#id74"><span class="problematic" id="id75">`message carbons`_</span></a>.</p>
</div> </div>
<div class="section" id="fullname"> <div class="section" id="fullname">
<h3><a class="toc-backref" href="#id53">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id56">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 <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> logged in user, otherwise the user&#8217;s vCard will be fetched.</p>
</div> </div>
<div class="section" id="hide-muc-server"> <div class="section" id="hide-muc-server">
<h3><a class="toc-backref" href="#id54">hide_muc_server</a><a class="headerlink" href="#hide-muc-server" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id57">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>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 <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 controlbox. Useful if you want to restrict users to a specific XMPP server of
your choosing.</p> your choosing.</p>
</div> </div>
<div class="section" id="i18n"> <div class="section" id="i18n">
<h3><a class="toc-backref" href="#id55">i18n</a><a class="headerlink" href="#i18n" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id58">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 <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> <tt class="docutils literal"><span class="pre">./locale/locales.js</span></tt> to see which locales are supported.</p>
</div> </div>
<div class="section" id="play-sounds"> <div class="section" id="play-sounds">
<h3><a class="toc-backref" href="#id56">play_sounds</a><a class="headerlink" href="#play-sounds" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id59">play_sounds</a><a class="headerlink" href="#play-sounds" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p> <p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<p>Plays a notification sound when you receive a personal message or when your
nickname is mentioned in a chat room.</p>
<p>Inside the <tt class="docutils literal"><span class="pre">./sounds</span></tt> directory of the Converse.js repo, you&#8217;ll see MP3 and Ogg <p>Inside the <tt class="docutils literal"><span class="pre">./sounds</span></tt> directory of the Converse.js repo, you&#8217;ll see MP3 and Ogg
formatted sound files. We need both, because neither format is supported by all browsers.</p> formatted sound files. We need both, because neither format is supported by all browsers.</p>
<p>For now, sound files are looked up by convention, not configuration. So to have <p>For now, sound files are looked up by convention, not configuration. So to have
...@@ -945,7 +1047,7 @@ it in both formats as <tt class="docutils literal"><span class="pre">http://your ...@@ -945,7 +1047,7 @@ it in both formats as <tt class="docutils literal"><span class="pre">http://your
<p><tt class="docutils literal"><span class="pre">http://yoursite.com</span></tt> should of course be your site&#8217;s URL.</p> <p><tt class="docutils literal"><span class="pre">http://yoursite.com</span></tt> should of course be your site&#8217;s URL.</p>
</div> </div>
<div class="section" id="prebind"> <div class="section" id="prebind">
<h3><a class="toc-backref" href="#id57">prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id60">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>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 <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> already authenticated (usually on the backend before page load).</p>
...@@ -958,7 +1060,7 @@ values as <tt class="docutils literal"><span class="pre">jid</span></tt>, <tt cl ...@@ -958,7 +1060,7 @@ 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> <p>Additionally, you have to specify <tt class="docutils literal"><span class="pre">bosh_service_url</span></tt>.</p>
</div> </div>
<div class="section" id="roster-groups"> <div class="section" id="roster-groups">
<h3><a class="toc-backref" href="#id58">roster_groups</a><a class="headerlink" href="#roster-groups" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id61">roster_groups</a><a class="headerlink" href="#roster-groups" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p> <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 show any roster groups you might have <p>If set to <tt class="docutils literal"><span class="pre">true</span></tt>, converse.js will show any roster groups you might have
configured.</p> configured.</p>
...@@ -970,7 +1072,7 @@ elsewhere.</p> ...@@ -970,7 +1072,7 @@ elsewhere.</p>
</div> </div>
</div> </div>
<div class="section" id="show-controlbox-by-default"> <div class="section" id="show-controlbox-by-default">
<h3><a class="toc-backref" href="#id59">show_controlbox_by_default</a><a class="headerlink" href="#show-controlbox-by-default" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id62">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>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, <p>The &#8220;controlbox&#8221; refers to the special chatbox containing your contacts roster,
status widget, chatrooms and other controls.</p> status widget, chatrooms and other controls.</p>
...@@ -980,13 +1082,13 @@ the page with class <em>toggle-controlbox</em>.</p> ...@@ -980,13 +1082,13 @@ the page with class <em>toggle-controlbox</em>.</p>
page load.</p> page load.</p>
</div> </div>
<div class="section" id="show-only-online-users"> <div class="section" id="show-only-online-users">
<h3><a class="toc-backref" href="#id60">show_only_online_users</a><a class="headerlink" href="#show-only-online-users" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id63">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>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. <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> Users with any other status (e.g. away, busy etc.) will not be shown.</p>
</div> </div>
<div class="section" id="storage"> <div class="section" id="storage">
<h3><a class="toc-backref" href="#id61">storage</a><a class="headerlink" href="#storage" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id64">storage</a><a class="headerlink" href="#storage" title="Permalink to this headline"></a></h3>
<p>Default: <tt class="docutils literal"><span class="pre">session</span></tt></p> <p>Default: <tt class="docutils literal"><span class="pre">session</span></tt></p>
<p>Valid options: <tt class="docutils literal"><span class="pre">session</span></tt>, <tt class="docutils literal"><span class="pre">local</span></tt>.</p> <p>Valid options: <tt class="docutils literal"><span class="pre">session</span></tt>, <tt class="docutils literal"><span class="pre">local</span></tt>.</p>
<p>This option determines the type of <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage">storage</a> <p>This option determines the type of <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage">storage</a>
...@@ -997,42 +1099,47 @@ privacy perspective a better choice.</p> ...@@ -997,42 +1099,47 @@ privacy perspective a better choice.</p>
the current tab or window containing a converse.js instance is open. As soon as the current tab or window containing a converse.js instance is open. As soon as
it&#8217;s closed, the data is cleared.</p> it&#8217;s closed, the data is cleared.</p>
<p>Data in localStorage on the other hand is kept indefinitely.</p> <p>Data in localStorage on the other hand is kept indefinitely.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Since version 0.8.0, the use of local storage is not recommended. The
statuses (online, away, busy etc.) of your roster contacts are cached in
the browser storage. If you use local storage, these values are stored for
multiple sessions, and they will likely become out of sync with your contacts&#8217;
actual statuses. The session storage doesn&#8217;t have this problem, because
roster contact statuses will not become out of sync in a single session,
only across more than one session.</p>
</div>
</div> </div>
<div class="section" id="use-otr-by-default"> <div class="section" id="use-otr-by-default">
<h3><a class="toc-backref" href="#id62">use_otr_by_default</a><a class="headerlink" href="#use-otr-by-default" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id65">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>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) <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> encrypted chat session every time you open a chat box.</p>
</div> </div>
<div class="section" id="use-vcards"> <div class="section" id="use-vcards">
<h3><a class="toc-backref" href="#id63">use_vcards</a><a class="headerlink" href="#use-vcards" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id66">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>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 <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 or not. VCards contain extra personal information such as your fullname and
avatar image.</p> avatar image.</p>
</div> </div>
<div class="section" id="visible-toolbar-buttons"> <div class="section" id="visible-toolbar-buttons">
<h3><a class="toc-backref" href="#id64">visible_toolbar_buttons</a><a class="headerlink" href="#visible-toolbar-buttons" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id67">visible_toolbar_buttons</a><a class="headerlink" href="#visible-toolbar-buttons" title="Permalink to this headline"></a></h3>
<p>Default:</p> <p>Default:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> <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="n">call</span><span class="p">:</span> <span class="n">false</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="n">clear</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s">&#39;clear&#39;</span><span class="p">:</span> <span class="n">true</span> <span class="n">emoticons</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="n">toggle_participants</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span> <span class="p">}</span>
</pre></div> </pre></div>
</div> </div>
<p>Allows you to show or hide buttons on the chat boxes&#8217; toolbars.</p> <p>Allows you to show or hide buttons on the chat boxes&#8217; toolbars.</p>
<ul> <ul>
<li><dl class="first docutils"> <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> <dt><em>call</em>:</dt>
<dd><p class="first">Provides a button with a picture of a telephone on it. <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> 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"><div class="highlight"><pre>converse.on(&#39;callButtonClicked&#39;, function(event, data) { <div class="last highlight-python"><div class="highlight"><pre>converse.on(&#39;callButtonClicked&#39;, function(event, data) {
console.log(&#39;Strophe connection is&#39;, data.connection); console.log(&#39;Strophe connection is&#39;, data.connection);
console.log(&#39;Bare buddy JID is&#39;, data.model.get(&#39;jid&#39;)); console.log(&#39;Bare buddy JID is&#39;, data.model.get(&#39;jid&#39;));
...@@ -1049,10 +1156,22 @@ When the call button is pressed, it will emit an event that can be used by a thi ...@@ -1049,10 +1156,22 @@ When the call button is pressed, it will emit an event that can be used by a thi
</dd> </dd>
</dl> </dl>
</li> </li>
<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>toggle_participants:</dt>
<dd><p class="first last">Shows a button for toggling (i.e. showing/hiding) the list of participants in a chat room.</p>
</dd>
</dl>
</li>
</ul> </ul>
</div> </div>
<div class="section" id="xhr-custom-status"> <div class="section" id="xhr-custom-status">
<h3><a class="toc-backref" href="#id65">xhr_custom_status</a><a class="headerlink" href="#xhr-custom-status" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id68">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> <p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
...@@ -1062,7 +1181,7 @@ When the call button is pressed, it will emit an event that can be used by a thi ...@@ -1062,7 +1181,7 @@ When the call button is pressed, it will emit an event that can be used by a thi
remote server.</p> remote server.</p>
</div> </div>
<div class="section" id="xhr-custom-status-url"> <div class="section" id="xhr-custom-status-url">
<h3><a class="toc-backref" href="#id66">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="#id69">xhr_custom_status_url</a><a class="headerlink" href="#xhr-custom-status-url" title="Permalink to this headline"></a></h3>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <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> <p class="last">XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).</p>
...@@ -1074,7 +1193,7 @@ message will be made.</p> ...@@ -1074,7 +1193,7 @@ 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> <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>
<div class="section" id="xhr-user-search"> <div class="section" id="xhr-user-search">
<h3><a class="toc-backref" href="#id67">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline"></a></h3> <h3><a class="toc-backref" href="#id70">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> <p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
...@@ -1091,7 +1210,7 @@ message will be made.</p> ...@@ -1091,7 +1210,7 @@ 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> 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>
<div class="section" id="xhr-user-search-url"> <div class="section" id="xhr-user-search-url">
<h3><a class="toc-backref" href="#id68">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="#id71">xhr_user_search_url</a><a class="headerlink" href="#xhr-user-search-url" title="Permalink to this headline"></a></h3>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <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> <p class="last">XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).</p>
...@@ -1119,7 +1238,7 @@ The available options are:</p> ...@@ -1119,7 +1238,7 @@ The available options are:</p>
<li class="right" style="margin-right: 10px"> <li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index" <a href="genindex.html" title="General Index"
>index</a></li> >index</a></li>
<li><a href="#">Converse.js 0.8.0 documentation</a> &raquo;</li> <li><a href="#">Converse.js 0.8.1 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
</div> </div>
......
docs/html/objects.inv
View file @ 481ea9e7
# Sphinx inventory version 2 # Sphinx inventory version 2
# Project: Converse.js # Project: Converse.js
# Version: 0.8.0 # Version: 0.8.1
# The remainder of this file is compressed using zlib. # The remainder of this file is compressed using zlib.
xm xm
{"]; {"];
......
docs/html/search.html
View file @ 481ea9e7
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; Converse.js 0.8.0 documentation</title> <title>Search &mdash; Converse.js 0.8.1 documentation</title>
<link rel="stylesheet" href="_static/stylesheet.css" type="text/css" /> <link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT: './', URL_ROOT: './',
VERSION: '0.8.0', VERSION: '0.8.1',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html', FILE_SUFFIX: '.html',
HAS_SOURCE: true HAS_SOURCE: true
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script> <script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="Converse.js 0.8.0 documentation" href="index.html" /> <link rel="top" title="Converse.js 0.8.1 documentation" href="index.html" />
<script type="text/javascript"> <script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); }); jQuery(function() { Search.loadIndex("searchindex.js"); });
</script> </script>
...@@ -49,7 +49,7 @@ ...@@ -49,7 +49,7 @@
<li class="right" style="margin-right: 10px"> <li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index" <a href="genindex.html" title="General Index"
accesskey="I">index</a></li> accesskey="I">index</a></li>
<li><a href="index.html">Converse.js 0.8.0 documentation</a> &raquo;</li> <li><a href="index.html">Converse.js 0.8.1 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
<section id="main_content" class="inner"> <section id="main_content" class="inner">
...@@ -94,7 +94,7 @@ ...@@ -94,7 +94,7 @@
<li class="right" style="margin-right: 10px"> <li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index" <a href="genindex.html" title="General Index"
>index</a></li> >index</a></li>
<li><a href="index.html">Converse.js 0.8.0 documentation</a> &raquo;</li> <li><a href="index.html">Converse.js 0.8.1 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
</div> </div>
......
docs/html/searchindex.js
View file @ 481ea9e7
Search.setIndex({envversion:42,terms:{all:0,partial:0,queri:0,lack:0,webchat:0,mp3:0,follow:0,row:0,privat:0,middl:0,sensit:0,punjab:0,elsewher:0,vcard:0,buddi:0,under:0,sens:0,spec:0,sent:0,global:0,everi:0,string:0,fals:0,multi:0,mechan:0,jack:0,veri:0,retriev:0,tri:[],button:0,messagetext:0,list:0,previou:0,correct:0,"try":0,item:0,sane:[],pleas:0,prevent:0,almond:0,prosodi:0,focu:0,past:0,second:0,download:0,further:0,port:0,folk:0,even:0,index:0,hide:0,appear:0,section:0,abl:0,access:0,delet:0,version:0,"new":0,net:0,"public":0,widget:0,themselv:[],messagexml:0,gener:0,here:0,bodi:0,typeerror:0,let:0,modifi:[],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,primit:0,prefer:0,ask:0,href:0,fake:0,sessionstorag:0,establish:0,from:0,zip:0,commun:0,doubl:0,two:0,websit:0,few:[],stylesheet:0,call:0,msg:0,until:0,tightli:0,more:0,emoticon:0,peopl:[],line:0,notic:0,particular:0,cach:0,must:0,account:[],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,getsess:[],give:0,challeng:0,share:0,templat:0,critic:0,proprietari:0,explor:0,onlin:0,callbuttonclick:0,occup:0,cours:0,multipl:0,goal:0,turn:0,anoth:0,deniabl:0,write:0,how:0,bosh_serv:[],sid:0,roster:0,verifi:0,perspect:0,updat:0,npm:0,regener:0,product:0,resourc:0,after:0,usabl:0,callback:0,mai:0,underscor:0,data:0,demonstr:0,man:0,repo:0,"short":0,attempt:0,practic:0,third:0,bind:0,secur:0,credenti:0,correspond:0,django:0,caus:0,inform:0,allow:0,parti:0,order:0,talk:0,feedback:[],chatbox:0,chatroomopen:0,over:0,move:0,becaus:0,chatboxopen:0,telephon:0,through:0,reconnect:0,paramet:0,streamlin:0,jid:0,"8147a27e4a7f9b55ffc85c2683f9529a":[],render:0,fit:0,fix:0,better:0,window:0,pend:0,persist:0,hidden:0,main:0,might:0,them:0,"return":0,thei:0,python:0,initi:0,rewriterul:0,instead:0,now:0,jump:0,name:0,edit:0,drop:0,crypto:0,separ:0,achiev:0,ejabberd:0,each:0,mean:0,subset:0,harm:0,chatboxfocus:0,michael:0,individu:0,idea:0,realli:0,"static":0,expect:0,our:0,happen:0,extract:0,special:0,out:0,shown:0,"3rd":0,space:0,open:0,proxy_pass:0,rel:0,internet:0,got:0,plural:0,factori:0,po2json:0,model:0,proxi:0,insid:0,state:0,standard:0,standalon:0,ajax:0,put:0,succesfulli:0,afterward:0,could:0,keep:0,thing:[],perhap:0,imposs:0,first:0,origin:0,softwar:0,directli:0,malici:0,onc:0,hoop:0,lastnam:0,number:0,yourself:0,instruct:0,alreadi:0,done:0,owner:0,custom:0,miss:0,suffic:0,size:0,differ:0,convent:0,top:0,attack:0,messag:0,attach:0,stori:0,jed:0,privaci:0,listen:0,luckili:0,assign:0,consol:0,option:0,tool:0,specifi:0,part:0,pars:0,ogg:0,exactli:0,than:0,serv:0,wide:[],kind:0,bloat:0,provid:0,remov:0,project:0,bridg:0,seriou:0,someothersit:0,browser:0,pre:0,analysi:0,sai:0,saa:0,session_kei:[],ani:0,packag:0,have:0,moffitt:0,element:0,issu:0,min:0,latter:0,yoursit:0,thorough:[],click:0,note:[],also:0,contact:0,take:0,which:0,therefor:0,sure:0,though:0,unsur:0,who:[],reach:0,most:0,plai:0,eavesdropp:0,homepag:0,"class":0,don:0,url:0,clear:0,doe:[],runtim:0,statuschang:0,bower:0,latest:0,xdomainrequest:0,devdepend:0,show:0,german:0,text:0,buddystatuschang:0,server_nam:0,identifi:0,fine:0,find:0,help:0,xml:0,current:0,onli:0,grunt:0,locat:0,execut:0,releas:0,stanza:0,haven:[],busi:0,folder:0,local:0,meant:0,stop:0,soon:0,opkod:[],nativ:0,cannot:0,cryptographi:0,increas:0,neither:0,enabl:0,emb:0,mainspec:0,patch:[],remot:0,contain:0,where:0,wiki:[],chatboxclos:0,stroph:0,see:0,bare:0,result:0,close:0,calendar:0,eventnam:0,best:0,concern:0,jqueri:0,statu:0,said:[],kei:0,inconveni:0,someth:0,written:0,muc:0,between:0,awai:0,experi:0,jasmin:0,across:0,attribut:0,altern:0,perfect:0,appreci:[],extend:0,screen:0,were:0,conjunct:0,job:0,entir:0,otherwis:0,"5e64a30272af065bd72258c565a03f2f":[],group:0,both:0,cor:0,instant:0,shortliv:0,conversej:0,avatar:0,etc:0,instanc:0,grain:0,mani:0,login:0,com:0,load:0,simpli:0,pot:0,solv:0,non:0,deploi:0,carbon:0,assum:0,malleabl:0,backend:0,quit:[],sucessfulli:0,addition:0,rebuild:0,due:0,been:0,compon:0,json:0,much:0,toolbar:0,subscrib:0,modern:0,fire:0,imag:0,xxx:0,rubi:0,convert:0,togeth:0,input:0,otr:0,plausibl:0,present:0,"case":0,myself:[],ident:0,look:0,gnu:0,servic:0,plugin:0,messagesend:0,defin:0,"while":0,abov:[],howev:0,hightlight:0,increment:0,helper:0,readi:0,site:0,itself:0,incom:0,rid:0,pat:0,harsh:0,minim:0,receiv:0,media:0,make:0,format:0,same:0,webpag:0,onconnectfacebook:[],html:0,unexpectedli:0,chatroom:0,document:[],medit:[],complet:0,signon:0,http:0,webserv:0,optim:0,upon:0,someon:[],hand:0,fairli:0,"50kb":0,user:0,uncaught:0,php:0,cssmin:0,recent:0,weibel:0,stateless:0,kept:0,bewar:0,firstli:0,markup:0,well:0,thought:0,person:0,client:0,command:0,wherebi:0,thi:0,choos:0,everyth:0,usual:0,plural_form:0,protocol:0,just:0,when:0,xep:0,file:0,languag:0,previous:0,web:0,fraught:0,xmlhttprequest:0,expos:0,field:0,extra:0,had:0,desktop:0,non_amd:0,versa:0,appli:0,els:0,match:0,build:0,applic:0,secreci:0,read:0,traffic:0,know:0,press:0,xss:0,like:0,specif:0,should:0,reload:0,manual:0,benefit:0,api:0,either:0,choic:0,popular:0,output:0,page:0,candi:0,indefinit:0,facebookconnect:[],revers:0,chatboxtoggl:0,deal:0,nplural:0,some:0,back:0,openfir:0,bottom:0,avoid:0,deploy:0,rewriteengin:0,track:0,allow_otr:0,inject:0,localhost:[],refer:0,somehow:0,plu:0,object:0,msg_receiv:0,host:0,repositori:0,post:0,panel:0,src:0,about:0,firstnam:0,controlbox:0,unfortun:0,stand:0,act:0,own:0,curiou:0,within:0,encod:0,automat:0,right:0,empti:0,wrap:0,chang:0,merg:[],git:0,log:0,wai:0,pictur:0,aren:0,transfer:0,"long":0,happi:0,avail:0,trigger:0,localstorag:0,includ:0,lot:0,suit:0,forward:0,"function":0,head:0,properli:0,form:0,bundl:0,maxim:0,link:0,buddystatusmessagechang:0,synonym:0,cryptograph:0,inlin:0,"true":0,bug:0,congratul:0,requirej:0,info:0,made:0,dirti:[],locale_data:0,possibl:0,whether:0,asynchron:0,below:0,those:0,toggl:0,legwork:0,emit:0,significantli:0,constant:0,creat:0,movim:[],decrypt:0,doesn:[],mode:0,msgmerg:0,exist:0,chat:0,face:0,probabl:0,tab:0,want:0,tip:[],detail:0,gettext:0,statusmessagechang:0,"default":0,valid:0,rememb:0,varieti:[],servernam:0,nice:0,node:0,intend:0,determin:0,duck:0,org:0,consid:0,stai:0,lang:0,longer:0,vice:0,directori:0,virtualhost:0,getjson:0,rule:0,ignor:0,token:0,potenti:0,time:0},objtypes:{},objnames:{},filenames:["index"],titles:["Quickstart (to get a demo up and running)"],objects:{},titleterms:{roster_group:0,multilingu:0,code:0,xmpp:0,session:0,jshint:0,depend:0,singl:0,configur:0,apach:0,add:0,anim:0,get:0,end:0,amd:0,nginx:0,facebook:[],front:0,requir:0,introduct:0,troubleshoot:0,authent:0,server:0,play_sound:0,bad:0,integr:[],debug:0,side:0,domain:0,set:[],habit:0,xhr_user_search_url:0,connect:0,pass:0,fullnam:0,event:0,librari:0,variabl:0,what:0,storag:0,xhr_custom_statu:0,content:0,show_only_online_us:0,use_otr_by_default:0,overcom:0,method:0,run:0,hide_muc_serv:0,javascript:0,visible_toolbar_button:0,bosh:0,xhr_custom_status_url:0,cache_otr_kei:0,manag:0,solut:0,restrict:0,auto_list_room:0,instal:0,jabber:0,your:0,script:0,support:0,submit:0,recommend:0,type:0,show_controlbox_by_default:0,notif:0,minifi:0,translat:0,i18n:0,sound:0,pull:0,bugfix:0,exampl:0,record:0,error:0,auto_reconnect:0,problem:0,featur:0,quickstart:0,forward_messag:0,demo:0,auto_subscrib:0,tag:0,tabl:0,need:0,check:0,bosh_service_url:0,prebind:0,develop:0,message_carbon:0,minif:0,cross:0,other:0,test:0,expose_rid_and_sid:0,you:0,css:0,befor:0,allow_contact_request:0,encrypt:0,xhr_user_search:0,off:0,use_vcard:0,request:0,allow_muc:0,without:0,conflict:0}}) Search.setIndex({envversion:42,terms:{"default":0,all:0,partial:0,edg:0,queri:0,lack:0,webchat:0,mp3:0,abil:0,follow:0,row:0,privat:0,middl:0,sensit:0,punjab:0,elsewher:0,send:0,vcard:0,buddi:0,under:0,sens:0,spec:0,sent:0,global:0,everi:0,string:0,fals:0,could:0,voic:0,ident:0,mechan:0,jack:0,veri:0,word:0,tri:[],button:0,messagetext:0,list:0,correct:0,"try":0,item:0,sane:[],increment:0,refer:0,pleas:0,prevent:0,almond:0,prosodi:0,focu:0,past:0,second:0,download:0,further:0,port:0,folk:0,even:0,index:0,hide:0,appear:0,section:0,abl:0,access:0,delet:0,version:0,"new":0,net:0,"public":0,jqueri:0,widget:0,themselv:[],messagexml:0,join:0,gener:0,here:0,bodi:0,typeerror:0,let:0,path:0,becom:0,modifi:[],sinc:0,valu:0,box:0,great:0,convers:0,mysit:0,current:0,ajax:0,implement:0,sorri:0,chanc:0,via:0,repositori:0,danger:0,primit:0,prefer:0,put:0,href:0,fake:0,sessionstorag:0,establish:0,from:0,zip:0,commun:0,deop:0,doubl:0,two:0,websit:0,few:[],stylesheet:0,busi:0,call:0,msg:0,until:0,tightli:0,more:0,emoticon:0,peopl:[],notic:0,site:0,particular:0,cach:0,must:0,account:[],retriev:0,room:[],work:0,uniqu:0,dev:0,xhr:0,legwork:0,can:0,lc_messag:0,purpos:0,root:0,fetch:0,control:0,getsess:[],give:0,challeng:0,share:0,templat:0,topic:0,critic:0,proprietari:0,explor:0,onlin:0,callbuttonclick:0,occup:0,cours:0,multipl:0,goal:0,turn:0,anoth:0,deniabl:0,write:0,how:0,bosh_serv:[],sid:0,instead:0,perspect:0,updat:0,npm:0,regener:0,product:0,resourc:0,after:0,usabl:0,mai:0,underscor:0,data:0,demonstr:0,man:0,opkod:[],"short":0,attempt:0,practic:0,third:0,seriou:0,secur:0,credenti:0,correspond:0,assign:0,caus:0,inform:0,maintain:0,allow:0,media:0,order:0,talk:0,feedback:[],chatbox:0,chatroomopen:0,over:0,move:0,becaus:0,chatboxopen:0,own:0,through:0,reconnect:0,still:0,paramet:0,streamlin:0,jid:0,"8147a27e4a7f9b55ffc85c2683f9529a":[],render:0,fit:0,fix:0,better:0,window:0,pend:0,persist:0,hidden:0,main:0,might:0,them:0,lastnam:0,"return":0,thei:0,python:0,encod:0,initi:0,rewriterul:0,mention:0,verifi:0,now:0,jump:0,name:0,edit:0,drop:0,crypto:0,separ:0,achiev:0,ejabberd:0,each:0,mean:0,subset:0,everyth:0,harm:0,chatboxfocus:0,michael:0,individu:0,idea:0,realli:0,"static":0,expect:0,our:0,happen:0,extract:0,special:0,out:0,shown:0,"3rd":0,space:0,miss:0,proxy_pass: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,element:0,ask:0,succesfulli:0,afterward:0,roominvites:0,fairli:0,blogpost:0,keep:0,thing:[],perhap:0,howev:0,nicknam:0,imposs:0,first:0,origin:0,softwar:0,directli:0,malici:0,onc:0,hoop:0,independ:0,cryptograph:0,number:0,yourself:0,instruct:0,alreadi:0,done:0,owner:0,happi:0,open:0,suffic:0,size:0,differ:0,convent:0,top:0,attack:0,messag:0,cssmin:0,attach:0,stori:0,draft:0,jed:0,privaci:0,recent:0,store:0,listen:0,luckili:0,consol:0,option:0,especi:0,tool:0,copi:0,specifi:0,direct:0,maxim:0,part:0,pars:0,kept:0,ogg:0,exactli:0,than:0,serv:0,wide:[],kind:0,bloat:0,provid:0,remov:0,project:0,bridg:0,bind:0,someothersit:0,browser:0,pre:0,"function":0,sai:0,saa:0,session_kei:[],ani:0,packag:0,properli:0,have:0,moffitt:0,django:0,issu:0,outbound:0,callback:0,latter:0,thorough:[],click:0,note:[],also:0,client:0,take:0,which:0,sure:0,roster:0,unsur:0,previou:0,reach:0,most:0,plai:0,plugin:0,eavesdropp:0,homepag:0,"class":0,don:0,url:0,clear:0,doe:[],runtim:0,statuschang:0,bower:0,usual:0,xdomainrequest:0,devdepend:0,show:0,german:0,text:0,buddystatuschang:0,server_nam:0,protocol:0,longer:0,fine:0,find:0,help:0,xml:0,yoursit:0,onli:0,grunt:0,locat:0,just:0,mute:0,releas:0,stanza:0,haven:[],experiment:0,roominvitereceiv:0,folder:0,local:0,meant:0,stop:0,soon:0,repo:0,nativ:0,cannot:0,cryptographi:0,increas:0,awai:0,enabl:0,emb:0,jasmin:0,mainspec:0,possibl:0,patch:[],remot:0,deploy:0,though:0,contain:0,ban:0,where:0,wiki:[],chatboxclos:0,stroph:0,see:0,bare:0,result:0,close:0,calendar:0,eventnam:0,best:0,concern:0,awar:0,statu:0,said:[],extend:0,inconveni:0,someth:0,particip:0,state:0,muc:0,between:0,"import":0,neither:0,experi:0,approach:0,across:0,attribut:0,altern:0,perfect:0,appreci:[],kei:0,screen:0,were:0,conjunct:0,extens:0,job:0,entir:0,"5e64a30272af065bd72258c565a03f2f":[],group:0,both:0,cor:0,instant:0,shortliv:0,conversej:0,myself:[],etc:0,instanc:0,grain:0,mani:0,login:0,com:0,load:0,simpli:0,within:0,pot:0,sync:0,solv:0,carbon:0,assum:0,malleabl:0,backend:0,quit:[],sucessfulli:0,addition:0,rebuild:0,due:0,been:0,compon:0,json:0,much:0,toolbar:0,interest:0,subscrib:0,modern:0,fire:0,imag:0,xxx:0,rubi:0,convert:0,togeth:0,els:0,otr:0,plausibl:0,present:0,"case":0,multi:0,therefor:0,look:0,gnu:0,servic:0,invit:0,messagesend:0,defin:0,"while":0,match:0,abov:[],observ:0,hightlight:0,engag:0,helper:0,readi:0,non:0,itself:0,incom:0,rid:0,pat:0,harsh:0,minim:0,receiv:0,parti:0,make:0,secreci:0,same:0,read:0,onconnectfacebook:[],html:0,unexpectedli:0,chatroom:0,document:[],medit:[],complet:0,status:0,signon:0,http:0,webserv:0,optim:0,roomview:0,upon:0,someon:[],hand:0,unhandl:0,"50kb":0,user:0,roominvit:0,uncaught:0,php:0,aka:0,forwarded_messag:0,weibel:0,stateless:0,moder:0,bewar:0,firstli:0,markup:0,min:0,well:0,object:0,thought:0,person:0,contact:0,command:[],wherebi:0,thi:0,choos:0,model:0,latest:0,plural_form:0,identifi:0,execut:0,tip:[],xep:0,languag:0,previous:0,web:0,xmlhttprequest:0,expos:0,field:0,extra:0,had:0,desktop:0,chat:[],non_amd:0,versa:0,appli:0,input:0,kick:0,build:0,applic:0,format:0,webpag:0,traffic:0,know:0,press:0,xss:0,like:0,specif:0,should:0,manual:0,benefit:0,api:0,either:0,choic:0,popular:0,output:0,page:0,candi:0,facebookconnect:[],revers:0,chatboxtoggl:0,deal:0,visibl:0,some:0,substitu:0,openfir:0,bottom:0,avoid:0,normal:0,rewriteengin:0,track:0,allow_otr:0,inject:0,speak:0,localhost:[],avatar:0,somehow:0,plu:0,who:[],msg_receiv:0,host:0,toggl:0,although:0,post:0,panel:0,src:0,about:0,actual:0,invitee_jid:0,firstnam:0,controlbox:0,unfortun:0,stand:0,act:0,telephon:0,curiou:0,deploi:0,toggle_particip:0,automat:0,right:0,empti:0,wrap:0,chang:0,merg:[],git:0,log:0,wai:0,pictur:0,aren:0,transfer:0,"long":0,custom:0,avail:0,trigger:0,localstorag:0,includ:0,lot:0,suit:0,forward:0,analysi:0,head:0,nplural:0,form:0,bundl:0,back:0,link:0,buddystatusmessagechang:0,synonym:0,line:0,inlin:0,"true":0,bug:0,congratul:0,requirej:0,info:0,made:0,dirti:[],locale_data:0,reload:0,whether:0,tab:0,asynchron:0,below:0,those:0,indefinit:0,otherwis:0,emit:0,significantli:0,constant:0,creat:0,movim:[],decrypt:0,doesn:0,mode:0,msgmerg:0,exist:0,file:0,face:0,probabl:0,again:0,want:0,when:0,detail:0,gettext:0,statusmessagechang:0,nick:0,valid:0,rememb:0,varieti:[],servernam:0,nice:0,node:0,intend:0,determin:0,duck:0,org:0,consid:0,stai:0,lang:0,fraught:0,vice:0,directori:0,virtualhost:0,getjson:0,rule:0,ignor:0,token:0,potenti:0,time:0},objtypes:{},objnames:{},filenames:["index"],titles:["Quickstart (to get a demo up and running)"],objects:{},titleterms:{roster_group:0,multilingu:0,code:0,xmpp:0,session:0,jshint:0,depend:0,configur:0,apach:0,add:0,anim:0,get:0,end:0,amd:0,nginx:0,facebook:[],front:0,requir:0,introduct:0,troubleshoot:0,authent:0,server:0,play_sound:0,xhr_custom_statu:0,integr:[],debug:0,manag:0,domain:0,set:[],habit:0,xhr_user_search_url:0,request:0,connect:0,pass:0,fullnam:0,event:0,librari:0,variabl:0,allow_muc:0,what:0,jabber:0,bad:0,content:0,use_otr_by_default:0,overcom:0,method:0,run:0,hide_muc_serv:0,javascript:0,visible_toolbar_button:0,bosh:0,css:0,xhr_custom_status_url:0,cache_otr_kei:0,side:0,solut:0,restrict:0,auto_list_room:0,instal:0,storag:0,your:0,script:0,support:0,submit:0,recommend:0,type:0,notif:0,minifi:0,translat:0,i18n:0,sound:0,pull:0,room:0,bugfix:0,record:0,error:0,auto_reconnect:0,problem:0,featur:0,quickstart:0,forward_messag:0,demo:0,auto_subscrib:0,tag:0,chat:0,tabl:0,need:0,check:0,bosh_service_url:0,prebind:0,develop:0,message_carbon:0,minif:0,cross:0,other:0,test:0,expose_rid_and_sid:0,you:0,singl:0,keepal:0,befor:0,allow_contact_request:0,encrypt:0,xhr_user_search:0,off:0,use_vcard:0,show_controlbox_by_default:0,without:0,show_only_online_us:0,exampl:0,command:0,conflict:0}})
\ No newline at end of file \ No newline at end of file
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