Table of Contents
When you download a specific release of Converse.js there will be two minified files inside the zip file.
You need to initialize Converse.js with configuration settings particular to +
You need to initialize Converse.js with configuration settings according to your requirements.
Please refer to the Configuration variables section further below for info on all the available configuration settings.
@@ -193,18 +193,17 @@ bottom of your page (after the closing </body> element).The index.html file inside the Converse.js repository may serve as a nice usable example.
These minified files provide the same demo-like functionality as is available -on the conversejs.org website. Useful for testing or demoing, but not very -practical.
-You’ll most likely want to implement some kind of single-signon solution for +on the conversejs.org website. Useful for testing or demoing.
+You’ll most likely want to implement some kind of single persistent session solution for your website, where users authenticate once in your website and then stay -logged into their XMPP session upon page reload.
+logged in to their XMPP session upon the next page reload.For more info on this, read: Prebinding and Single Session Support.
You might also want to have more fine-grained control of what gets included in the minified Javascript file. Read Configuration and Minification for more info on how to do that.
Even though you can connect to public XMPP servers on the conversejs.org website, Converse.js is not really meant to be a “Software-as-a-service” (SaaS) webchat.
@@ -217,176 +216,15 @@ webchat experience and that you have control over the data. The latter being a requirement for many sites dealing with sensitive information.You’ll need to set up your own XMPP server and in order to have Session Support (i.e. single-signon functionality whereby users are authenticated once and stay -logged in to XMPP upon page reload) you will also have to add some server-side +logged in to XMPP upon page reload) you will likely also have to add some server-side code.
The What you will need section has more information on all these requirements.
Converse.js implements XMPP as its messaging protocol, and therefore needs -to connect to an XMPP/Jabber server (Jabber is really just a synonym for XMPP).
-You can connect to public XMPP servers like jabber.org but if you want to -have Session Support you’ll have to set up your own XMPP server.
-You can find a list of public XMPP servers/providers on xmpp.net and a list of -servers that you can set up yourself on xmpp.org.
-Your website and Converse.js use HTTP as protocol to communicate with -the webserver. HTTP connections are stateless and usually shortlived.
-XMPP on the other hand, is the protocol that enables instant messaging, and -its connections are stateful and usually longer.
-To enable a web application like Converse.js to communicate with an XMPP -server, we need a proxy in the middle that can act as a bridge between the two -protocols.
-The index.html file inside the
-This is the job of a connection manager. A connection manager can be either a -standalone application or part of an XMPP server. Popular XMPP servers such as -ejabberd, prosody and -openfire all include their own connection managers -(but you usually have to enable them in the configuration).
-Standalone connection managers also exist, see for example Punjab.
-The demo on the Converse.js homepage uses a connection manager located at https://bind.conversejs.org. -This connection manager is available for testing purposes only, please don’t use it in production.
-Lets say your domain is example.org, but the domain of your connection -manager is example.com.
-HTTP requests are made by Converse.js to the connection manager via XmlHttpRequests (XHR). -Until recently, it was not possible to make such requests to a different domain -than the one currently being served (to prevent XSS attacks).
-Luckily there is now a standard called CORS (Cross-origin resource sharing), which enables exactly that. -Modern browsers support CORS, but there are problems with Internet Explorer < -10.
-IE 8 and 9 partially support CORS via a proprietary implementation called -XDomainRequest. There is a Strophe.js plugin which you can use to enable -support for XDomainRequest when it is present.
-In IE < 8, there is no support for CORS.
-Instead of using CORS, you can add a reverse proxy in -Apache/Nginx which serves the connection manager under the same domain as your -website. This will remove the need for any cross-domain XHR support.
-Assuming your site is accessible on port 80 for the domain mysite.com -and your connection manager manager is running at someothersite.com/http-bind.
-The bosh_service_url value you want to give Converse.js to overcome -the cross-domain restriction is mysite.com/http-bind and not -someothersite.com/http-bind.
-Your nginx or apache configuration will look as follows:
-http {
- server {
- listen 80
- server_name mysite.com;
- location ~ ^/http-bind/ {
- proxy_pass http://someothersite.com;
- }
- }
-}
-<VirtualHost *:80>
- ServerName mysite.com
- RewriteEngine On
- RewriteRule ^/http-bind(.*) http://someothersite.com/http-bind$1 [P,L]
-</VirtualHost>
-It’s possible to enable single-site login, whereby users already -authenticated in your website will also automatically be logged in on the chat server,
-This session should also persist across page loads. In other words, we don’t -want the user to have to give their chat credentials every time they reload the -page.
-To do this you will require a BOSH server -for converse.js to connect to (see the bosh_service_url under Configuration variables) -as well as a BOSH client on your own server (written for example in Python, Ruby or PHP) that will -do the pre-authentication before the web page loads.
-Note
-A BOSH server acts as a bridge between HTTP, the protocol of the web, and -XMPP, the instant messaging protocol. -Converse.js can only communicate via HTTP, but we need to communicate with -an XMPP server in order to chat. So the BOSH server acts as a middle man, -translating our HTTP requests into XMPP stanzas and vice versa.
-Jack Moffitt has a great blogpost about this and even provides an example Django application to demonstrate it.
-When you authenticate to the XMPP server on your backend application (for -example via a BOSH client in Django), you’ll receive two tokens, RID (request ID) and SID (session ID).
-The Session ID (SID) is a unique identifier for the current session. This -number stays constant for the entire session.
-The Request ID (RID) is a unique identifier for the current request (i.e. -page load). Each page load is a new request which requires a new unique RID. -The best way to achieve this is to simply increment the RID with each page -load.
-When you initialize converse.js in your browser, you need to pass it these two -tokens. Converse.js will then use them to attach to the session you just -created.
-You can embed the RID and SID tokens in your HTML markup or you can do an -XMLHttpRequest call to your server and ask it to return them for you.
-Below is one example of how this could work. An Ajax call is made to the -relative URL /prebind and it expects to receive JSON data back.
-$.getJSON('/prebind', function (data) {
- converse.initialize({
- prebind: true,
- bosh_service_url: data.bosh_service_url,
- jid: data.jid,
- sid: data.sid,
- rid: data.rid
- });
-);
-Here’s what’s happening:
-The JSON data returned from the Ajax call to example.com/prebind contains the user’s JID (jabber ID), RID, SID and the URL to the -BOSH server (also called a connection manager).
-These values are then passed to converse.js’s initialize method.
-Note
-If you want to enable single session support, you need to set prebind: true -when calling converse.initialize (see ./index.html). -Additionally you need to pass in valid jid, sid, rid and -bosh_service_url values.
-See xmpp-prebind-php by -Michael Weibel and the folks from Candy chat.
-See this example Django application by Jack Moffitt.
-Converse.js supports Off-the-record (OTR) encrypted messaging.
The OTR protocol not only encrypts your messages, it provides ways to @@ -408,13 +246,13 @@ Converse.js in order to avoid most eavesdroppers, if you need serious communications privacy, then you’re much better off using native software.
From version 0.8.1 Converse.js can play a sound notification when you receive a message.
For more info, please see the play_sounds configuration setting.
Converse.js is translated into multiple languages. The default build, converse.min.js, includes all languages.
Languages increase the size of the Converse.js significantly.
@@ -422,9 +260,9 @@ message. make a custom build which includes only those languages that you need.Here are the different commands that may be used in a chat room:
| Event Type | -When is it triggered? | -Example | -
|---|---|---|
| initialized | -Once converse.js has been initialized. | -converse.on('initialized', function () { ... }); | -
| ready | -After connection has been established and converse.js has got all its ducks in a row. | -converse.on('ready', function () { ... }); | -
| reconnect | -After the connection has dropped. Converse.js will attempt to reconnect when not in prebind mode. | -converse.on('reconnect', function () { ... }); | -
| message | -When a message is received. | -converse.on('message', function (messageXML) { ... }); | -
| messageSend | -When a message will be sent out. | -converse.on('messageSend', function (messageText) { ... }); | -
| roster | -When the roster is updated. | -converse.on('roster', function (items) { ... }); | -
| callButtonClicked | -When a call button (i.e. with class .toggle-call) on a chat box has been clicked. | -converse.on('callButtonClicked', function (connection, model) { ... }); | -
| chatBoxOpened | -When a chat box has been opened. | -converse.on('chatBoxOpened', function (chatbox) { ... }); | -
| chatRoomOpened | -When a chat room has been opened. | -converse.on('chatRoomOpened', function (chatbox) { ... }); | -
| chatBoxClosed | -When a chat box has been closed. | -converse.on('chatBoxClosed', function (chatbox) { ... }); | -
| chatBoxFocused | -When the focus has been moved to a chat box. | -converse.on('chatBoxFocused', 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) { ... }); | -
| statusMessageChanged | -When own custom status message has changed. | -converse.on('statusMessageChanged', function (message) { ... }); | -
| buddyStatusChanged | -When a chat buddy’s chat status has changed. | -converse.on('buddyStatusChanged', function (buddy, status) { ... }); | -
| buddyStatusMessageChanged | -When a chat buddy’s custom status message has changed. | -converse.on('buddyStatusMessageChanged', function (buddy, messageText) { ... }); | -
Note
-see also the event api methods, not listed here.
+The API documented here is available in Converse.js 0.8.4 and higher. +Earlier versions of Converse.js might have different API methods or none at all.
In the Converse.js API, you traverse towards a logical grouping, from +which you can then call certain standardised accessors and mutators, like:
+.get
+.set
+.add
+.all
+.remove
+This is done to increase readability and to allow intuitive method chaining.
+For example, to get a contact, you would do the following:
+converse.contacts.get('jid@example.com');
+To get multiple contacts, just pass in an array of jids:
+converse.contacts.get(['jid1@example.com', 'jid2@example.com']);
+Here follows now a breakdown of all API groupings and methods:
Note
+This method is the one exception of a method which is not logically grouped +as explained above.
+Initializes converse.js. This method must always be called when using converse.js.
The initialize method takes a map (also called a hash or dictionary) of @@ -931,12 +656,14 @@ converse.js.
Returns a map of attributes for a given buddy (i.e. roster contact), specified by JID (Jabber ID).
Example:
-converse.getBuddy('buddy@example.com')
+converse.contacts.get('buddy@example.com')
The map of attributes:
@@ -999,17 +726,410 @@ by JID (Jabber ID).
Returns the current SID (Session ID) value.
+Returns an object/map representing a chat box (without opening or affecting that chat box).
+Example:
+converse.chats.get('buddy@example.com')
+The returned chat box contains the following methods:
+| Method | +Description | +
|---|---|
| endOTR | +End an OTR (Off-the-record) session. | +
| get | +Get an attribute (i.e. accessor). | +
| initiateOTR | +Start an OTR (off-the-record) session. | +
| maximize | +Minimize the chat box. | +
| minimize | +Maximize the chat box. | +
| set | +Set an attribute (i.e. mutator). | +
The get and set methods can be used to retrieve and change the following attributes:
+| Attribute | +Description | +
|---|---|
| height | +The height of the chat box. | +
| url | +The URL of the chat box heading. | +
Returns a token, either the RID or SID token depending on what’s asked for.
+Example:
+converse.tokens.get('rid')
+Converse.js emits events to which you can subscribe from your own Javascript.
+Concerning events, the following methods are available under the “listen” +grouping:
+on(eventName, callback):
+++Calling the on method allows you to subscribe to an event. +Every time the event fires, the callback method specified by callback will be +called.
+Parameters:
++
+- eventName is the event name as a string.
+- callback is the callback method to be called when the event is emitted.
+For example:
+++converse.listen.on('message', function (messageXML) { ... }); +
once(eventName, callback):
+++Calling the once method allows you to listen to an event +exactly once.
+Parameters:
++
+- eventName is the event name as a string.
+- callback is the callback method to be called when the event is emitted.
+For example:
+++converse.listen.once('message', function (messageXML) { ... }); +
not(eventName, callback)
+++To stop listening to an event, you can use the not method.
+Parameters:
++
+- eventName is the event name as a string.
+- callback refers to the function that is to be no longer executed.
+For example:
+++converse.listen.not('message', function (messageXML) { ... }); +
Note
+see also the “listen” grouping API section above.
+Here are the different events that are emitted:
+| Event Type | +When is it triggered? | +Example | +
|---|---|---|
| initialized | +Once converse.js has been initialized. | +converse.on('initialized', function () { ... }); | +
| ready | +After connection has been established and converse.js has got all its ducks in a row. | +converse.on('ready', function () { ... }); | +
| reconnect | +After the connection has dropped. Converse.js will attempt to reconnect when not in prebind mode. | +converse.on('reconnect', function () { ... }); | +
| message | +When a message is received. | +converse.on('message', function (messageXML) { ... }); | +
| messageSend | +When a message will be sent out. | +converse.on('messageSend', function (messageText) { ... }); | +
| noResumeableSession | +When keepalive=true but there aren’t any stored prebind tokens. | +converse.on('noResumeableSession', function () { ... }); | +
| roster | +When the roster is updated. | +converse.on('roster', function (items) { ... }); | +
| callButtonClicked | +When a call button (i.e. with class .toggle-call) on a chat box has been clicked. | +converse.on('callButtonClicked', function (connection, model) { ... }); | +
| chatBoxOpened | +When a chat box has been opened. | +converse.on('chatBoxOpened', function (chatbox) { ... }); | +
| chatRoomOpened | +When a chat room has been opened. | +converse.on('chatRoomOpened', function (chatbox) { ... }); | +
| chatBoxClosed | +When a chat box has been closed. | +converse.on('chatBoxClosed', function (chatbox) { ... }); | +
| chatBoxFocused | +When the focus has been moved to a chat box. | +converse.on('chatBoxFocused', 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) { ... }); | +
| statusMessageChanged | +When own custom status message has changed. | +converse.on('statusMessageChanged', function (message) { ... }); | +
| buddyStatusChanged | +When a chat buddy’s chat status has changed. | +converse.on('buddyStatusChanged', function (buddy, status) { ... }); | +
| buddyStatusMessageChanged | +When a chat buddy’s custom status message has changed. | +converse.on('buddyStatusMessageChanged', function (buddy, messageText) { ... }); | +
Please make sure to read the section Development and that you have installed +all development dependencies (long story short, you can run npm install +and then grunt fetch).
+We use require.js to keep track of Converse.js and its dependencies and to +to bundle them together in a single minified file fit for deployment to a +production site.
+To minify the Javascript and CSS, run the following command:
+grunt minify
+Javascript will be bundled and minified with require.js‘s optimization tool, +using almond.
+You can read more about require.js’s optimizer here.
+CSS is minified via cssmin.
+Note
+Translations take up a lot of space and will bloat your minified file. +At the time of writing, all the translations add about 50KB of extra data to +the minified javascript file. Therefore, make sure to only +include those languages that you intend to support and remove from +./locale/locales.js those which you don’t need. Remember to rebuild the +minified file afterwards.
+The gettext POT file located in ./locale/converse.pot is the template +containing all translations and from which for each language an individual PO +file is generated.
+The POT file contains all translateable strings extracted from converse.js.
+To make a user facing string translateable, wrap it in the double underscore helper +function like so:
+__('This string will be translated at runtime');
+After adding the string, you’ll need to regenerate the POT file, like so:
+make pot
+To create a new PO file for a language in which converse.js is not yet +translated into, do the following
+Note
+In this example we use Polish (pl), you need to substitute ‘pl’ to your own language’s code.
+mkdir -p ./locale/pl/LC_MESSAGES
+msginit -i ./locale/converse.pot -o ./locale/pl/LC_MESSAGES/converse.po -l pl
+You can then create or update the PO file for a specific language by doing the following:
+Note
+In this example we use German (de), you need to substitute ‘de’ to your own language’s code.
+msgmerge ./locale/de/LC_MESSAGES/converse.po ./locale/converse.pot -U
+To do this for ALL languages, run:
+make po
+The resulting PO file is then what gets translated.
+If you’ve created a new PO file, please make sure to add the following +attributes at the top of the file (under Content-Transfer-Encoding). They are +required as configuration settings for Jed, the Javascript translations library +that we’re using.
+"domain: converse\n"
+"lang: de\n"
+"plural_forms: nplurals=2; plural=(n != 1);\n"
+Unfortunately Jed cannot use the PO files directly. We have to generate from it +a file in JSON format and then put that in a .js file for the specific +language.
+To generate JSON from a PO file, you’ll need po2json for node.js. Run the +following command to install it (npm being the node.js package manager):
+npm install po2json
+You can then convert the translations into JSON format:
+po2json locale/de/LC_MESSAGES/converse.po locale/de/LC_MESSAGES/converse.json
+Now from converse.json paste the data as a value for the “locale_data” key in the +object in the language’s .js file.
+So, if you are for example translating into German (language code ‘de’), you’ll +create or update the file ./locale/LC_MESSAGES/de.js with the following code:
+(function (root, factory) {
+ define("de", ['jed'], function () {
+ return factory(new Jed({
+ "domain": "converse",
+ "locale_data": {
+ // Paste the JSON data from converse.json here
+ }
+ })
+ }
+}(this, function (i18n) {
+ return i18n;
+}));
+making sure to also paste the JSON data as value to the “locale_data” key.
+Note
+If you are adding translations for a new language that is not already supported, +you’ll have to add the language path in main.js and make one more edit in ./locale/locales.js +to make sure the language is loaded by require.js.
+Congratulations, you’ve now succesfully added your translations. Sorry for all +those hoops you had to jump through.
+You are using other Javascript libraries (like JQuery plugins), and +get errors like these in your browser console:
+Uncaught TypeError: Object [object Object] has no method 'xxx' from example.js
+First, find out which object is referred to by Object [object Object].
+It will probably be the jQuery object $ or perhaps the underscore.js object _.
+For the purpose of demonstration, I’m going to assume its $, but the same +rules apply if its something else.
+The bundled and minified default build of converse.js, converse.min.js +includes within it all of converse.js’s dependencies, which include for example jQuery.
+If you are having conflicts where attributes or methods aren’t available +on the jQuery object, you are probably loading converse.min.js (which +includes jQuery) as well as your own jQuery version separately.
+What then happens is that there are two $ objects (one from +converse.js and one from the jQuery version you included manually) +and only one of them has been extended to have the methods or attributes you require.
+Which jQuery object you get depends on the order in which you load the libraries.
+There are multiple ways to solve this issue.
+Firstly, make sure whether you really need to include a separate version of +jQuery. Chances are that you don’t. If you can remove the separate +version, your problem should be solved, as long as your libraries are loaded in +the right order.
+Either case, whether you need to keep two versions or not, the solution depends +on whether you’ll use require.js to manage your libraries or whether you’ll +load them manually.
+Instead of using converse.min.js, manage all the libraries in your project +(i.e. converse.js and its dependencies plus all other libraries you use) as one +require.js project, making sure everything is loaded in the correct order.
+Then, before deployment, you make your own custom minified build that bundles everything +you need.
+Take a look at non_amd.html +in the converse.js repo.
+It shows in which order the libraries must be loaded via <script> tags. Add +your own libraries, making sure that they are loaded in the correct order (e.g. +jQuery plugins must load after jQuery).
+The included minified JS and CSS files can be used for demoing or testing, but you’ll want to configure Converse.js to suit your needs before you deploy it on your website.
@@ -1023,9 +1143,9 @@ all the available configuration settings. JS file so that it will include the new settings. Please refer to the Minification section for more info on how to do this.Default: true
Allow users to add one another as contacts. If this is set to false, the Add a contact widget, Contact Requests and Pending Contacts roster @@ -1033,23 +1153,23 @@ sections will all not appear. Additionally, all incoming contact requests will b ignored.
Default: true
Allow multi-user chat (muc) in chatrooms. Setting this to false will remove the Chatrooms tab from the control box.
Default: false
If true, and the XMPP server on which the current user is logged in supports multi-user chat, then a list of rooms on that server will be fetched.
@@ -1059,24 +1179,24 @@ features, number of occupants etc.), so on servers with many rooms this option will create lots of extra connection traffic.Default: true
Automatically reconnect to the XMPP server if the connection drops unexpectedly.
Default: false
If true, the user will automatically subscribe back to any contact requests.
Connections to an XMPP server depend on a BOSH connection manager which acts as a middle man between HTTP and XMPP.
See here for more information.
Default: false
Let the OTR (Off-the-record encryption) private key be cached in your browser’s session storage.
@@ -1095,20 +1215,23 @@ current session. Previous sessions however cannot be decrypted.Default: false
If set to true, debugging output will be logged to the browser console.
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.
+See also:
+Default: false
Support for XEP-0280: Message Carbons
In order to keep all IM clients for a user engaged in a conversation, @@ -1119,11 +1242,11 @@ tab serves as a separate IM client.
(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 +solve this problem, while `forwarded_messages`_ uses stanza forwarding
Default: false
Allow the prebind tokens, RID (request ID) and SID (session ID), to be exposed globally via the API. This allows other scripts served on the same page to use @@ -1132,7 +1255,7 @@ these values.
and inject fake chat messages.Default: false
If set to true, sent messages will also be forwarded to the sending user’s bare JID (their Jabber ID independent of any chat clients aka resources).
@@ -1141,27 +1264,27 @@ and not just the one from which it was actually sent.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.
This feature uses Stanza forwarding, see also XEP 0297: Stanza Forwarding
-For an alternative approach, see also `message carbons`_.
+For an alternative approach, see also `message carbons`_.
If you are using prebinding, can specify the fullname of the currently logged in user, otherwise the user’s vCard will be fetched.
Default: false
Hide the server input field of the form inside the Room panel of the controlbox. Useful if you want to restrict users to a specific XMPP server of your choosing.
Specify the locale/language. The language must be in the locales object. Refer to ./locale/locales.js to see which locales are supported.
Default: false
Plays a notification sound when you receive a personal message or when your nickname is mentioned in a chat room.
@@ -1174,20 +1297,64 @@ it in both formats as http://yourhttp://yoursite.com should of course be your site’s URL.
Default: false
+See also: Prebinding and Single Session Support
Use this option when you want to attach to an existing XMPP connection that was already authenticated (usually on the backend before page load).
This is useful when you don’t want to render the login form on the chat control box with each page load.
-For prebinding to work, your backend server must authenticate for you, and -then return a JID (jabber ID), SID (session ID) and RID (Request ID).
-If you set prebind to true, you have to make sure to also pass in these -values as jid, sid, rid.
-Additionally, you have to specify bosh_service_url.
+For prebinding to work, you must set up a pre-authenticated BOSH session, +for which you will receive a JID (jabber ID), SID (session ID) and RID +(Request ID).
+These values (rid, sid and jid) need to be passed into +converse.initialize (with the exception of keepalive, see below).
+Additionally, you also have to specify a bosh_service_url.
+The prebind and keepalive options can be used together.
+The keepalive option caches the rid, sid and jid values +(henceforth referred to as session tokens) one receives from a prebinded +BOSH session, in order to re-use them when the page reloads.
+However, if besides setting keepalive to true, you also set prebind +to true, and you pass in valid session tokens to converse.initialize, +then those passed in session tokens will be used instead of any tokens cached by +keepalive.
+If you set prebind to true and don’t pass in the session tokens to +converse.initialize, then converse.js will look for tokens cached by +keepalive.
+If you’ve set keepalive and prebind to true, don’t pass in session +tokens and converse.js doesn’t find any cached session tokens, then +converse.js will emit an event noResumeableSession and exit.
+This allows you to start a prebinded session with valid tokens, and then fall +back to keepalive for maintaining that session across page reloads. When +for some reason keepalive doesn’t have cached session tokens anymore, you +can listen for the noResumeableSession event and take that as a cue that +you should again prebind in order to get valid session tokens.
+Here is a code example:
+converse.on('noResumeableSession', function () {
+ $.getJSON('/prebind', function (data) {
+ converse.initialize({
+ prebind: true,
+ keepalive: true,
+ bosh_service_url: 'https://bind.example.com',
+ jid: data.jid,
+ sid: data.sid,
+ rid: data.rid
+ });
+ });
+});
+converse.initialize({
+ prebind: true,
+ keepalive: true,
+ bosh_service_url: 'https://bind.example.com'
+}));
+Default: false
If set to true, converse.js will show any roster groups you might have configured.
@@ -1199,7 +1366,7 @@ elsewhere.Default: false
The “controlbox” refers to the special chatbox containing your contacts roster, status widget, chatrooms and other controls.
@@ -1209,13 +1376,13 @@ the page with class toggle-controlbox. page load.Default: false
If set to true, only online users will be shown in the contacts roster. Users with any other status (e.g. away, busy etc.) will not be shown.
Default: false
If set to true, Converse.js will automatically try to initiate an OTR (off-the-record) encrypted chat session every time you open a chat box.
Default: true
Determines whether the XMPP server will be queried for roster contacts’ VCards or not. VCards contain extra personal information such as your fullname and avatar image.
Default:
{
call: false,
@@ -1298,7 +1465,7 @@ When the call button is pressed, it will emit an event that can be used by a thi
Default: false
Note
@@ -1308,7 +1475,7 @@ When the call button is pressed, it will emit an event that can be used by a thi remote server.Note
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
@@ -1320,7 +1487,7 @@ message will be made.The message itself is sent in the request under the key msg.
Default: false
Note
@@ -1337,7 +1504,7 @@ message will be made. corresponds to a matched user and needs the keys id and fullname.Note
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js index b06499430..175a13182 100644 --- a/docs/html/searchindex.js +++ b/docs/html/searchindex.js @@ -1 +1 @@ -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,typeerror:0,sensit:0,punjab:0,base64:0,readabl:0,descript:[],send:0,vcard:0,buddi:0,under:0,sens:0,spec:0,sent:0,global:0,everi:0,string:0,fals:0,voic:0,offlin:0,ident:0,mechan:0,jack:0,veri:0,join:0,tri:[],button:0,messagetext:0,list:0,correct:0,"try":0,item:0,sane:[],refer:0,awai:0,pleas:0,prevent:0,almond:0,prosodi:0,focu:0,jump: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,awar:0,"new":0,net:0,"public":0,widget:0,full:0,themselv:[],messagexml:0,gener:0,here:0,bodi:0,middl:0,let:0,path:0,becom:0,modifi:[],sinc:0,valu:0,box:0,great:0,convers:0,mysit:0,current:0,ajax:0,fetch: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,known:0,realli:0,cach:0,must:0,none:0,word:0,room:[],work:0,uniqu:0,dev:0,xhr:0,legwork:0,can:0,lc_messag:0,purpos:0,root:0,could: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,alwai:0,cours:0,multipl:0,goal:0,turn:0,anoth:0,deniabl:0,write:0,how:0,bosh_serv:[],sid:0,roster:0,instead:0,perspect:0,updat:0,npm:0,regener:0,product:0,resourc:0,after:0,usabl:0,wrong: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,report:0,own:0,through:0,reconnect:0,still:0,paramet:[],streamlin:0,jid:0,"8147a27e4a7f9b55ffc85c2683f9529a":[],render:0,fit:0,fix:0,better:0,window:0,pend:0,persist:0,mail:0,hidden:0,main:0,might:0,them:0,lastnam:0,"return":0,thei:0,python:0,encod:0,initi:[],rewriterul:0,mention:0,verifi:0,now:0,choic: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,map:0,michael:0,individu:0,idea:0,librelist:0,"static":0,expect:0,django: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,differ:0,standard:0,standalon:0,reason:0,dictionari:0,ask:0,succesfulli:0,afterward:0,roominvites:0,fairli:0,blogpost:0,keep:0,thing:[],perhap:0,place: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,given: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,past:0,kind:0,bloat:0,provid:0,remov:0,jqueri: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,increment:0,moffitt:0,element:0,issu:0,outbound:0,built:0,callback:0,latter:0,thorough:[],click:0,note:[],also:0,client:0,take:0,which:0,sure:0,normal:0,unsur:0,previou:0,reach:0,most:0,plai:0,eavesdropp:0,homepag:0,"class":0,don:0,url:0,clear:0,doe:0,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,chat_statu:0,haven:[],experiment:0,roominvitereceiv:0,folder:0,local:0,meant:0,wide:[],stop:0,account:[],soon:0,repo:0,nativ:0,cannot:0,cryptographi:0,increas:0,neither:0,enabl:0,emb:0,jasmin:0,mainspec:0,possibl:0,patch:0,remot: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,movim:[],statu:0,said:[],extend:0,inconveni:0,someth:0,particip:0,state:0,muc:0,between:0,"import":0,subscript:0,experi:0,approach:0,across:0,hash: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,howev: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:[],user_id:0,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,last:0,otr:0,plausibl:0,present:0,invit:0,"case":0,multi:0,therefor:0,look:0,gnu:0,servic:0,plugin: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,welcom: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,again: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,human: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:[],avatar:0,have: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,deploy:0,rewriteengin:0,usernam:0,allow_otr:0,inject:0,speak:0,localhost:[],either: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,project: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,gone:0,constant:0,creat:0,retriev:0,decrypt:0,doesn:0,mode:0,msgmerg:0,exist:0,file:0,face:0,probabl:0,denot:0,image_typ: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,harsh:0,org:0,vcard_upd:0,elsewher:0,track:0,consid:0,conversej: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,paramet:[],depend:0,configur:0,apach:0,descript:[],add:0,anim:0,get:0,end:0,amd:0,initi: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,api:0,auto_list_room:0,instal:0,storag:0,your:0,script:0,support:0,submit:0,getsid:0,recommend:0,type:0,notif:0,minifi:0,translat:0,i18n:0,getrid: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,argument:[],tag:0,chat:0,tabl:0,need:0,check:0,bosh_service_url:0,prebind:0,develop:0,message_carbon:0,getbuddi: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,minif: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 +Search.setIndex({envversion:42,terms:{all:0,partial:0,edg:[],chain:0,queri:0,lack:0,standardis:0,webchat:0,mp3:0,abil:0,follow:0,row:0,privat:0,typeerror:0,sensit:0,punjab:0,base64:0,readabl:0,allow_otr:[],send:0,vcard:0,buddi:0,under:0,sens:0,spec:0,sent:0,file:0,global:0,everi:0,string:0,fals:0,voic:0,offlin:0,mechan:0,jack:0,fall:0,veri:[],affect:0,tri:[],button:0,messagetext:0,list:0,virtualhost:0,correct:0,"try":0,item:0,sane:[],pleas:0,prevent:0,almond:0,prosodi:0,focu:0,jump:0,second:0,jid2:0,jid1:0,download:0,further:0,port:0,folk:0,even:0,index:0,hide:0,appear:0,section:0,abl:0,current:0,delet:0,version:0,"new":0,net:0,"public":0,widget:0,full:0,themselv:[],messagexml:0,join:0,gener:0,here:0,bodi:0,middl:0,let:0,path:0,becom:0,modifi:[],sinc:0,valu:0,box:0,great:0,convers:0,mysit:0,anymor: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,deop:0,doubl:0,two:0,next:0,websit:0,few:[],stylesheet:0,call:0,msg:0,until:0,tightli:0,more:0,emoticon:0,peopl:[],line:0,notic:0,particular:[],known:0,cach:0,must:0,none:0,word:0,room:[],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,topic:0,critic:0,movim:[],proprietari:0,explor:0,onlin:0,callbuttonclick:0,occup:0,alwai:0,cours:0,multipl:0,goal:0,turn:0,anoth:0,deniabl:0,write:0,how:0,bosh_serv:[],sid:0,verifi:0,perspect:0,updat:0,npm:0,map:0,product:0,resourc:0,earlier:0,usabl:0,shortliv:0,wrong:0,mai:0,pat:0,underscor:0,data:0,demonstr:0,man:0,repo:0,"short":0,attempt:0,practic:[],third:0,nativ:0,seriou:0,secur:0,credenti:0,correspond:0,element:0,caus:0,inform:0,maintain:0,allow:0,parti:0,order:0,talk:0,feedback:[],chatbox:0,chatroomopen:0,over:0,move:0,becaus:0,chatboxopen:0,increas:0,telephon:0,through:0,reconnect:0,still:0,paramet:[],streamlin:0,jid:0,"8147a27e4a7f9b55ffc85c2683f9529a":[],render:0,fit:0,fix:0,better:0,whether:0,window:0,pend:0,persist:0,mail:0,hidden:0,main:0,might:0,hoop:0,them:0,lastnam:0,"return":0,thei:0,python:0,toggle_particip:0,initi:[],rewriterul:0,mention:0,instead:0,aka:0,now:0,choic:0,name:0,edit:0,drop:0,crypto:0,separ:0,achiev:0,ejabberd:0,each:0,complet:0,mean:0,subset:0,status:0,harm:0,chatboxfocus:0,regener:0,experiment:[],michael:0,individu:0,idea:0,librelist: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,after:0,proxi:0,insid:0,state:0,given:0,standard:0,standalon:0,ajax:0,dictionari:0,put:0,succesfulli:0,afterward:0,roominvites:0,unhandl:[],could:0,keep:0,thing:[],perhap:0,place:0,nicknam:0,imposs:0,token:[],first:0,origin:0,softwar:0,directli:0,malici:0,onc:0,arrai:0,independ: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,mkdir:0,attack:0,messag:0,attach:0,stori:0,draft:0,jed:0,privaci:0,forwarded_messag:0,store:0,listen:[],luckili:0,assign:0,consol:0,option:0,especi:0,tool:0,copi:0,specifi:0,direct:0,maxim:0,part:0,pars:0,moder:0,ogg:0,exactli:0,than:0,serv:0,past:0,kind:0,bloat:0,provid:0,remov:0,jqueri:0,bridg:0,bind:0,toward:0,someothersit:0,browser:0,pre:0,analysi:0,sai:0,saa:0,session_kei:[],ani:0,packag:0,properli:0,increment:0,moffitt:0,django:0,normal:0,issu:0,outbound:0,built:0,callback:0,latter:0,yoursit:0,thorough:[],click:0,note:[],also:0,contact:[],take:0,which:0,therefor:0,sure:0,roster:0,unsur:0,previou:0,reach:0,most:0,plai:0,eavesdropp:0,homepag:0,"class":0,msginit:0,don:0,bug:0,url:0,clear:0,doe:0,noresumeablesess:0,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,henceforth:0,onli:0,grunt:0,locat:0,execut:0,explain:0,mute:0,releas:0,stanza:0,chat_statu:0,haven:[],busi:0,roominvitereceiv:0,folder:0,local:0,meant:0,wide:[],stop:0,account:[],soon:0,opkod:[],initiateotr:0,cannot:0,cryptographi:0,report:0,subscript:0,enabl:0,emb:0,approach:0,mainspec:0,multi:0,patch:0,remot:0,deploy: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:[],statu:0,said:[],kei:0,inconveni:0,someth:0,particip:0,written:0,muc:0,between:0,"import":0,neither:0,experi:0,jasmin:0,across:0,attribut:0,altern:0,perfect:0,accord:0,appreci:[],extend:0,screen:0,were:0,conjunct:0,extens:0,job:0,entir:0,otherwis:0,"5e64a30272af065bd72258c565a03f2f":[],group:[],both:0,cor:0,instant:0,plugin:0,howev:0,avatar:0,etc:0,instanc:0,grain:0,logic:0,mani:0,login:0,com:0,load:0,simpli:0,pot:0,height:0,sync:0,solv:0,non:0,deploi:0,carbon:0,constant:0,assum:0,malleabl:0,backend:0,quit:[],user_id:0,sucessfulli:0,addition:0,rebuild:0,due:0,been:0,accessor:0,compon:0,json:0,much:0,besid:0,toolbar:0,interest:0,subscrib:0,modern:0,fire:0,imag:0,xxx:0,rubi:0,convert:0,togeth:0,input:0,last:0,otr:0,plausibl:0,present:0,"case":0,myself:[],ident:0,look:0,gnu:0,servic:0,invit:0,messagesend:0,defin:0,"while":0,kick:0,abov:0,observ:0,hightlight:0,engag:0,helper:0,readi:0,site:0,itself:0,incom:0,rid:0,mutat:0,welcom:0,minim:0,receiv:0,media:0,make:0,format:0,same:0,webpag:0,onconnectfacebook:[],html:0,unexpectedli:0,chatroom:0,document:0,medit:[],higher:0,breakdown:0,signon:0,http:0,webserv:0,denot:0,optim:0,roomview:0,upon:0,someon:[],hand:0,fairli:0,"50kb":0,user:0,roominvit:0,uncaught:0,php:0,cssmin:0,recent:0,weibel:0,stateless:0,travers:0,kept:0,bewar:0,firstli:0,markup:0,min:0,well:0,thought:0,person:0,client:0,command:[],wherebi:0,thi:0,choos:0,everyth:0,usual:0,plural_form:0,protocol:0,just:0,when:0,xep:0,human:0,polish:0,yet:0,languag:0,previous:0,web:0,fraught:0,xmlhttprequest:0,expos:0,nick:0,extra:0,had:0,except:0,desktop:0,cue:0,non_amd:0,versa:0,appli:0,els:0,match:0,build:0,applic:0,secreci:0,read:0,intuit:0,traffic:0,know:0,press:0,xss:0,like:0,specif:0,should:0,reload:0,manual:0,benefit:0,api:[],either:0,have:0,popular:0,output:0,mode:0,page:0,candi:0,indefinit:0,facebookconnect:[],revers:0,chatboxtoggl:0,who:[],deal:0,visibl:0,some:0,substitu:0,certain:0,endotr:0,openfir:0,bottom:0,avoid:0,though:0,rewriteengin:0,usernam:0,substitut:0,exit:0,inject:0,speak: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,actual:0,would:0,invitee_jid:0,firstnam:0,controlbox:0,unfortun:0,stand:0,act:0,own:0,curiou:0,inlin: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,start:0,trigger:0,localstorag:0,includ:0,lot:0,suit:0,forward:0,"function":0,project:0,head:0,nplural:0,form:0,bundl:0,back:0,link:0,buddystatusmessagechang:0,synonym:0,cryptograph:0,realli:0,"true":0,awai:0,congratul:0,requirej:0,info:0,made:0,dirti:[],tab:0,possibl:0,"default":0,access:0,asynchron:0,below:0,those:0,toggl:0,legwork:0,emit:0,significantli:0,gone:0,hash:0,creat:0,retriev:0,decrypt:0,doesn:0,repres:0,msgmerg:0,exist:0,chat:[],face:0,probabl:0,again:0,image_typ:0,want:0,tip:[],detail:0,gettext:0,statusmessagechang:0,field:0,valid:0,rememb:0,varieti:[],servernam:0,nice:0,node:0,intend:0,determin:0,duck:0,harsh:0,org:0,vcard_upd:0,elsewher:0,track:0,consid:0,conversej:0,stai:0,lang:0,longer:0,vice:0,directori:0,descript:[],getjson:0,rule:0,ignor:0,locale_data:0,potenti:0,time:0},objtypes:{},objnames:{},filenames:["index"],titles:["Quickstart (to get a demo up and running)"],objects:{},titleterms:{demo:0,roster_group:0,multilingu:0,code:0,xmpp:0,session:0,jshint:0,paramet:[],group:0,singl:0,configur:0,apach:0,add:0,anim:0,get:0,end:0,amd:0,initi: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,allow_otr:0,use_otr_by_default:0,overcom:0,method:[],run:0,hide_muc_serv:0,javascript:0,visible_toolbar_button:0,bosh:0,depend:0,xhr_custom_status_url:0,cache_otr_kei:0,manag:0,solut:0,restrict:0,api:0,auto_list_room:0,instal:0,jabber:[],your:0,script:0,support:0,submit:0,getsid:[],recommend:0,type:0,listen:0,show_controlbox_by_default:0,notif:0,minifi:0,translat:0,i18n:0,getrid:[],sound:0,pull:0,room:0,bugfix:0,exampl:0,record:0,error:0,auto_reconnect:0,problem:0,featur:0,quickstart:0,forward_messag:0,descript:[],auto_subscrib:0,argument:[],tag:0,chat:0,tabl:0,need:0,check:0,bosh_service_url:0,prebind:0,develop:0,message_carbon:0,getbuddi:[],cross:0,other:0,test:0,expose_rid_and_sid:0,you:0,css:0,keepal:0,befor:0,allow_contact_request:0,encrypt:0,minif:0,xhr_user_search:0,off:0,use_vcard:0,request:0,without:0,allow_muc:0,contact:0,command:0,token:0,conflict:0}}) \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 6bf2eeb50..b41f75a01 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -515,11 +515,38 @@ You can run both the tests and jshint in one go by calling: Developer API ============= -.. note:: see also the `event api methods`_, not listed here. +.. note:: The API documented here is available in Converse.js 0.8.4 and higher. + Earlier versions of Converse.js might have different API methods or none at all. + +In the Converse.js API, you traverse towards a logical grouping, from +which you can then call certain standardised accessors and mutators, like:: + + .get + .set + .add + .all + .remove + +This is done to increase readability and to allow intuitive method chaining. + +For example, to get a contact, you would do the following:: + + converse.contacts.get('jid@example.com'); + +To get multiple contacts, just pass in an array of jids:: + + converse.contacts.get(['jid1@example.com', 'jid2@example.com']); + + +**Here follows now a breakdown of all API groupings and methods**: + initialize ---------- +.. note:: This method is the one exception of a method which is not logically grouped + as explained above. + Initializes converse.js. This method must always be called when using converse.js. @@ -544,15 +571,18 @@ Example:: }); -getBuddy --------- +"contacts" grouping +------------------- + +get +~~~ Returns a map of attributes for a given buddy (i.e. roster contact), specified by JID (Jabber ID). Example:: - converse.getBuddy('buddy@example.com') + converse.contacts.get('buddy@example.com') The map of attributes: @@ -590,17 +620,19 @@ The map of attributes: | vcard_updated | When last the buddy's VCard was updated. | +----------------+--------------------------------------------------------------------------------------------------------------------------------------+ -getChatBox ----------- +"chats" grouping +---------------- + +get +~~~ Returns an object/map representing a chat box (without opening or affecting that chat box). Example:: - converse.getChatBox('buddy@example.com') + converse.chats.get('buddy@example.com') -The returned chat box contains the following methods: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +*The returned chat box contains the following methods:* +-------------+------------------------------------------+ | Method | Description | @@ -618,8 +650,7 @@ The returned chat box contains the following methods: | set | Set an attribute (i.e. mutator). | +-------------+------------------------------------------+ -The get and set methods can be used to retrieve and change the following attributes: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +*The get and set methods can be used to retrieve and change the following attributes:* +-------------+-----------------------------------------------------+ | Attribute | Description | @@ -629,39 +660,25 @@ The get and set methods can be used to retrieve and change the following attribu | url | The URL of the chat box heading. | +-------------+-----------------------------------------------------+ -getRID ------- +"tokens" grouping +----------------- -Returns the current RID (request ID) value. +get +~~~ -getSID ------- - -Returns the current SID (Session ID) value. - -openChatBox ------------ - -Opens a chat box and returns an object/map representating that chat box. -If the chat box is already open, its text area will be focused. +Returns a token, either the RID or SID token depending on what's asked for. Example:: - converse.openChatBox('buddy@example.com') + converse.tokens.get('rid') -Refer to `getChatBox`_ for more information on the object returned by this -method (which is the same for both). - - -Events -====== +"listen" grouping +----------------- Converse.js emits events to which you can subscribe from your own Javascript. -Concerning events, the following methods are available: - -Event API Methods ------------------ +Concerning events, the following methods are available under the "listen" +grouping: * **on(eventName, callback)**: @@ -676,7 +693,7 @@ Event API Methods For example:: - converse.on('message', function (messageXML) { ... }); + converse.listen.on('message', function (messageXML) { ... }); * **once(eventName, callback)**: @@ -690,17 +707,25 @@ Event API Methods For example:: - converse.once('message', function (messageXML) { ... }); + converse.listen.once('message', function (messageXML) { ... }); -* **off(eventName, callback)** +* **not(eventName, callback)** - To stop listening to an event, you can use the ``off`` method. + To stop listening to an event, you can use the ``not`` method. Parameters: * ``eventName`` is the event name as a string. * ``callback`` refers to the function that is to be no longer executed. + For example:: + + converse.listen.not('message', function (messageXML) { ... }); + +Events +====== + +.. note:: see also the `"listen" grouping`_ API section above. Event Types ----------- @@ -750,7 +775,6 @@ Here are the different events that are emitted: +--------------------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ - Minification ============ diff --git a/spec/converse.js b/spec/converse.js index 632cce89b..46a6e1c25 100644 --- a/spec/converse.js +++ b/spec/converse.js @@ -10,82 +10,130 @@ } (this, function ($, mock, test_utils) { return describe("Converse", $.proxy(function(mock, test_utils) { - beforeEach($.proxy(function () { - test_utils.closeAllChatBoxes(); - test_utils.clearBrowserStorage(); - converse.rosterview.model.reset(); - test_utils.createContacts('current'); + describe("The \"tokens\" API", $.proxy(function () { + beforeEach($.proxy(function () { + test_utils.closeAllChatBoxes(); + test_utils.clearBrowserStorage(); + converse.rosterview.model.reset(); + test_utils.createContacts('current'); + }, converse)); + + it("has a method for retrieving the next RID", $.proxy(function () { + var old_connection = converse.connection; + converse.connection._proto.rid = '1234'; + converse.expose_rid_and_sid = false; + expect(converse_api.tokens.get('rid')).toBe(null); + converse.expose_rid_and_sid = true; + expect(converse_api.tokens.get('rid')).toBe('1234'); + converse.connection = undefined; + expect(converse_api.tokens.get('rid')).toBe(null); + // Restore the connection + converse.connection = old_connection; + }, converse)); + + it("has a method for retrieving the SID", $.proxy(function () { + var old_connection = converse.connection; + converse.connection._proto.sid = '1234'; + converse.expose_rid_and_sid = false; + expect(converse_api.tokens.get('sid')).toBe(null); + converse.expose_rid_and_sid = true; + expect(converse_api.tokens.get('sid')).toBe('1234'); + converse.connection = undefined; + expect(converse_api.tokens.get('sid')).toBe(null); + // Restore the connection + converse.connection = old_connection; + }, converse)); }, converse)); - it("has an API method for retrieving the next RID", $.proxy(function () { - var old_connection = converse.connection; - converse.connection._proto.rid = '1234'; - converse.expose_rid_and_sid = false; - expect(converse_api.getRID()).toBe(null); + describe("The \"contacts\" API", $.proxy(function () { + beforeEach($.proxy(function () { + test_utils.closeAllChatBoxes(); + test_utils.clearBrowserStorage(); + converse.rosterview.model.reset(); + test_utils.createContacts('current'); + }, converse)); - converse.expose_rid_and_sid = true; - expect(converse_api.getRID()).toBe('1234'); - - converse.connection = undefined; - expect(converse_api.getRID()).toBe(null); - // Restore the connection - converse.connection = old_connection; + it("has a method 'get' which returns a wrapped contact", $.proxy(function () { + // TODO: test multiple JIDs passed in + var jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@localhost'; + expect(converse_api.contacts.get('non-existing@jabber.org')).toBeFalsy(); + var attrs = converse_api.contacts.get(jid); + expect(typeof attrs).toBe('object'); + expect(attrs.fullname).toBe(mock.cur_names[0]); + expect(attrs.jid).toBe(jid); + }, converse)); }, converse)); - it("has an API method for retrieving the SID", $.proxy(function () { - var old_connection = converse.connection; - converse.connection._proto.sid = '1234'; - converse.expose_rid_and_sid = false; - expect(converse_api.getSID()).toBe(null); + describe("The \"chats\" API", $.proxy(function() { + beforeEach($.proxy(function () { + test_utils.closeAllChatBoxes(); + test_utils.clearBrowserStorage(); + converse.rosterview.model.reset(); + test_utils.createContacts('current'); + }, converse)); - converse.expose_rid_and_sid = true; - expect(converse_api.getSID()).toBe('1234'); - - converse.connection = undefined; - expect(converse_api.getSID()).toBe(null); - // Restore the connection - converse.connection = old_connection; + it("has a method 'get' which returns a wrapped chat box object", $.proxy(function () { + // TODO: test multiple JIDs passed in + // FIXME: when a non-existing chat box is "get(ted)", it's + // opened, which we don't want... + expect(converse_api.chats.get('non-existing@jabber.org')).toBeFalsy(); // test on user that doesn't exist. + var jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@localhost'; + var box = converse_api.chats.get(jid); + expect(box instanceof Object).toBeTruthy(); + expect(box.get('box_id')).toBe(b64_sha1(jid)); + var chatboxview = this.chatboxviews.get(jid); + expect(chatboxview.$el.is(':visible')).toBeTruthy(); + }, converse)); }, converse)); - it("has an API method for retrieving a buddy's attributes", $.proxy(function () { - var jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@localhost'; - expect(converse_api.getBuddy('non-existing@jabber.org')).toBeFalsy(); - var attrs = converse_api.getBuddy(jid); - expect(typeof attrs).toBe('object'); - expect(attrs.fullname).toBe(mock.cur_names[0]); - expect(attrs.jid).toBe(jid); + describe("The DEPRECATED API", $.proxy(function() { + beforeEach($.proxy(function () { + test_utils.closeAllChatBoxes(); + test_utils.clearBrowserStorage(); + converse.rosterview.model.reset(); + test_utils.createContacts('current'); + }, converse)); + + it("has a method for retrieving the next RID", $.proxy(function () { + var old_connection = converse.connection; + converse.connection._proto.rid = '1234'; + converse.expose_rid_and_sid = false; + expect(converse_api.getRID()).toBe(null); + + converse.expose_rid_and_sid = true; + expect(converse_api.getRID()).toBe('1234'); + + converse.connection = undefined; + expect(converse_api.getRID()).toBe(null); + // Restore the connection + converse.connection = old_connection; + }, converse)); + + it("has a method for retrieving the SID", $.proxy(function () { + var old_connection = converse.connection; + converse.connection._proto.sid = '1234'; + converse.expose_rid_and_sid = false; + expect(converse_api.getSID()).toBe(null); + + converse.expose_rid_and_sid = true; + expect(converse_api.getSID()).toBe('1234'); + + converse.connection = undefined; + expect(converse_api.getSID()).toBe(null); + // Restore the connection + converse.connection = old_connection; + }, converse)); + + it("has a method for retrieving a buddy's attributes", $.proxy(function () { + var jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@localhost'; + expect(converse_api.getBuddy('non-existing@jabber.org')).toBeFalsy(); + var attrs = converse_api.getBuddy(jid); + expect(typeof attrs).toBe('object'); + expect(attrs.fullname).toBe(mock.cur_names[0]); + expect(attrs.jid).toBe(jid); + }, converse)); }, converse)); - it("has an API method, openChatBox, for opening a chat box for a buddy", $.proxy(function () { - expect(converse_api.openChatBox('non-existing@jabber.org')).toBeFalsy(); // test on user that doesn't exist. - var jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@localhost'; - var box = converse_api.openChatBox(jid); - expect(box instanceof Object).toBeTruthy(); - expect(box.get('box_id')).toBe(b64_sha1(jid)); - var chatboxview = this.chatboxviews.get(jid); - expect(chatboxview.$el.is(':visible')).toBeTruthy(); - }, converse)); - - it("will focus an already open chat box, if the openChatBox API method is called for it.", $.proxy(function () { - // Calling openChatBox on an already open chat will focus it. - var jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@localhost'; - var chatboxview = this.chatboxviews.get(jid); - spyOn(chatboxview, 'focus'); - test_utils.openChatBoxFor(jid); - box = converse_api.openChatBox(jid); - expect(chatboxview.focus).toHaveBeenCalled(); - expect(box.get('box_id')).toBe(b64_sha1(jid)); - - }, converse)); - - it("has an API method, getChatBox, for retrieving chat box", $.proxy(function () { - var jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@localhost'; - expect(converse_api.getChatBox(jid)).toBeFalsy(); - test_utils.openChatBoxFor(jid); - var box = converse_api.getChatBox(jid); - expect(box instanceof Object).toBeTruthy(); - expect(box.get('box_id')).toBe(b64_sha1(jid)); - }, converse)); }, converse, mock, test_utils)); }));