2015-05-02 01:21:25 +02:00
.. raw :: html
<div id="banner"><a href="https://github.com/jcbrand/converse.js/blob/master/docs/source/development.rst">Edit me on GitHub</a></div>
2015-02-05 15:58:51 +01:00
.. _development:
2014-12-07 00:53:17 +01:00
===========
Development
===========
.. contents :: Table of Contents
2014-12-07 01:19:01 +01:00
:depth: 2
2014-12-07 00:53:17 +01:00
:local:
If you want to work with the non-minified Javascript and CSS files you'll soon
notice that there are references to a missing *components* folder. Please
follow the instructions below to create this folder and fetch Converse's
3rd-party dependencies.
.. note ::
2015-01-22 17:55:43 +01:00
Windows environment: We recommend installing the required tools using `Chocolatey <https://chocolatey.org/> `_
You will need Node.js (nodejs.install), Git (git.install) and optionally to build using Makefile, GNU Make (make)
2014-12-07 12:37:33 +01:00
If you have trouble setting up a development environment on Windows,
please read `this post <http://librelist.com/browser//conversejs/2014/11/5/openfire-converse-and-visual-studio-questions/#b28387e7f8f126693b11598a8acbe810> `_
in the mailing list.:
2014-12-07 00:53:17 +01:00
Install the development and front-end dependencies
==================================================
We use development tools (`Grunt <http://gruntjs.com> `_ and `Bower <http://bower.io> `_ )
which depend on Node.js and npm (the Node package manager).
If you don't have Node.js installed, you can download and install the latest
version `here <https://nodejs.org/download> `_ .
2014-12-07 12:37:33 +01:00
Also make sure you have `` Git `` installed. `Details <http://git-scm.com/book/en/Getting-Started-Installing-Git> `_ .
2014-12-07 00:53:17 +01:00
2015-01-22 17:55:43 +01:00
.. note ::
Windows users should use Chocolatey as recommended above.:
2015-04-26 07:56:22 +02:00
.. note ::
2015-04-26 11:13:35 +02:00
Debian & Ubuntu users : apt-get install git npm nodejs-legacy
2015-04-26 07:56:22 +02:00
2014-12-07 00:53:17 +01:00
Once you have *Node.js* and *git* installed, run the following command inside the Converse.js
directory:
::
make dev
2015-04-02 02:01:53 +02:00
On Windows you need to specify Makefile.win to be used by running: ::
2015-01-22 17:55:43 +01:00
make -f Makefile.win dev
2014-12-07 00:53:17 +01:00
Or alternatively, if you don't have GNU Make:
::
npm install
bower update
2015-01-22 17:55:43 +01:00
2014-12-07 00:53:17 +01:00
This will first install the Node.js development tools (like Grunt and Bower)
and then use Bower to install all of Converse.js's front-end dependencies.
The front-end dependencies are those javascript files on which
Converse.js directly depends and which will be loaded in the browser.
If you are curious to know what the different dependencies are:
* Development dependencies:
Take a look at whats under the *devDependencies* key in
`package.json <https://github.com/jcbrand/converse.js/blob/master/package.json> `_ .
* Front-end dependencies:
See *dependencies* in
`bower.json <https://github.com/jcbrand/converse.js/blob/master/bower.json> `_ .
.. note ::
After running `` ` make dev ` `` , you should now have a new directory *components* ,
which contains all the front-end dependencies of Converse.js.
If this directory does NOT exist, something must have gone wrong.
Double-check the output of `` ` make dev ` `` to see if there are any errors
listed. For support, you can write to the mailing list: conversejs@librelist.com
With AMD and require.js (recommended)
=====================================
Converse.js uses `require.js <http://requirejs.org> `_ to asynchronously load dependencies.
If you want to develop or customize converse.js, you'll want to load the
non-minified javascript files.
Add the following two lines to the *<head>* section of your webpage:
.. code-block :: html
<link rel="stylesheet" type="text/css" media="screen" href="converse.css">
<script data-main="main" src="components/requirejs/require.js"></script>
require.js will then let the main.js file be parsed (because of the *data-main*
attribute on the *script* tag), which will in turn cause converse.js to be
parsed.
Without AMD and require.js
==========================
Converse.js can also be used without require.js. If you for some reason prefer
to use it this way, please refer to
`non_amd.html <https://github.com/jcbrand/converse.js/blob/master/non_amd.html> `_
for an example of how and in what order all the Javascript files that converse.js
depends on need to be loaded.
Before submitting a pull request
================================
2015-06-16 00:18:15 +02:00
Please follow the usual github workflow. Create your own local fork of this repository,
make your changes and then submit a pull request.
2014-12-07 00:53:17 +01:00
2015-06-16 00:18:15 +02:00
Before submitting a pull request
--------------------------------
2014-12-07 00:53:17 +01:00
2015-06-16 00:18:15 +02:00
Please read the `style guide </docs/html/style_guide.html> `_ and make sure that your code follows it.
2014-12-07 00:53:17 +01:00
2015-06-16 00:18:15 +02:00
Add tests for your bugfix or feature
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add a test for any bug fixed or feature added. We use Jasmine
for testing.
2014-12-07 00:53:17 +01:00
2015-06-16 00:18:15 +02:00
Take a look at `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html> `_
and the `spec files <https://github.com/jcbrand/converse.js/blob/master/tests.html> `_
to see how tests are implemented.
2014-12-07 00:53:17 +01:00
2015-06-16 00:18:15 +02:00
Check that the tests pass
~~~~~~~~~~~~~~~~~~~~~~~~~
Check that all tests complete sucessfully.
2014-12-07 00:53:17 +01:00
2015-06-16 00:18:15 +02:00
Run `` make check `` in your terminal or open `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html> `_
in your browser.
2014-12-07 00:53:17 +01:00
Developer API
=============
.. 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
.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']);
2015-02-25 18:31:09 +01:00
To get all contacts, simply call `` get `` without any jids::
converse.contacts.get();
2014-12-07 00:53:17 +01:00
**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.
The `initialize`
:ref: `configuration-variables` .
Example:
.. code-block :: javascript
converse.initialize({
allow_otr: true,
auto_list_rooms: false,
auto_subscribe: false,
bosh_service_url: 'https://bind.example.com',
hide_muc_server: false,
i18n: locales['en'],
keepalive: true,
play_sounds: true,
prebind: false,
show_controlbox_by_default: true,
debug: false,
roster_groups: true
});
"contacts" grouping
-------------------
get
~~~
2015-02-25 18:31:09 +01:00
This method is used to retrieve roster contacts.
2014-12-07 00:53:17 +01:00
2015-02-25 18:31:09 +01:00
To get a single roster contact, call the method with the contact's JID (Jabber ID):
2014-12-07 00:53:17 +01:00
converse.contacts.get('buddy@example.com')
2015-02-25 18:31:09 +01:00
To get multiple contacts, pass in an array of JIDs::
converse.contacts.get(['buddy1@example.com', 'buddy2@example.com'])
To return all contacts, simply call `` get `` without any parameters::
converse.contacts.get()
The returned roster contact objects have these attributes:
2014-12-07 00:53:17 +01:00
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | |
+================+======================================================================================================================================+
| ask | If ask === 'subscribe', then we have asked this person to be our chat buddy. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| fullname | The person's full name. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| jid | The person's Jabber/XMPP username. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| requesting | If true, then this person is asking to be our chat buddy. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| subscription | The subscription state between the current user and this chat buddy. Can be `none` `to` `from` `both`
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| id | A unique id, same as the jid. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| chat_status | The person's chat status. Can be `online` `offline` `busy` `xa` `away`
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| user_id | The user id part of the JID (the part before the `@`
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| resources | The known resources for this chat buddy. Each resource denotes a separate and connected chat client. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| groups | The roster groups in which this chat buddy was placed. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| status | Their human readable custom status message. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| image_type | The image's file type. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| image | The Base64 encoded image data. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| url | The buddy's website URL, as specified in their VCard data. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| vcard_updated | When last the buddy's VCard was updated. |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
2015-03-30 12:02:28 +02:00
add
~~~
Add a contact.
Provide the JID of the contact you want to add::
2015-04-24 12:03:22 +02:00
converse.contacts.add('buddy@example.com')
2015-03-30 12:02:28 +02:00
2015-04-24 12:03:22 +02:00
You may also provide the fullname. If not present, we use the jid as fullname::
2015-03-30 12:02:28 +02:00
2015-04-24 12:03:22 +02:00
converse.contacts.add('buddy@example.com', 'Buddy')
2015-03-30 12:02:28 +02:00
2014-12-07 00:53:17 +01:00
"chats" grouping
----------------
get
~~~
2015-04-02 02:01:53 +02:00
Returns an object representing a chat box.
2015-02-25 18:31:09 +01:00
To return a single chat box, provide the JID of the contact you're chatting
with in that chat box::
converse.chats.get('buddy@example.com')
To return an array of chat boxes, provide an array of JIDs::
converse.chats.get(['buddy1@example.com', 'buddy2@example.com'])
To return all open chat boxes, call the method without any JIDs::
converse.chats.get()
open
~~~~
2014-12-07 00:53:17 +01:00
2015-02-25 18:31:09 +01:00
Opens a chat box and returns an object representing a chat box.
To open a single chat box, provide the JID of the contact::
2014-12-07 00:53:17 +01:00
2015-03-11 12:47:09 +01:00
converse.chats.open('buddy@example.com')
2014-12-07 00:53:17 +01:00
2015-02-25 18:31:09 +01:00
To return an array of chat boxes, provide an array of JIDs::
2015-03-11 12:47:09 +01:00
converse.chats.open(['buddy1@example.com', 'buddy2@example.com'])
2015-02-25 18:31:09 +01:00
2015-04-02 02:01:53 +02:00
*The returned chat box object contains the following methods:*
2014-12-07 00:53:17 +01:00
+-------------+------------------------------------------+
| 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). |
+-------------+------------------------------------------+
2015-02-25 18:31:09 +01:00
| close | Close the chat box. |
+-------------+------------------------------------------+
2015-04-02 02:01:53 +02:00
| open | Opens the chat box. |
+-------------+------------------------------------------+
2014-12-07 00:53:17 +01:00
*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. |
+-------------+-----------------------------------------------------+
2015-04-05 08:36:26 +02:00
"rooms" grouping
----------------
get
~~~
Returns an object representing a multi user chat box (room).
Similar to chats.get API
open
~~~~
Opens a multi user chat box and returns an object representing it.
Similar to chats.get API
To open a single multi user chat box, provide the JID of the room::
2015-04-16 06:23:13 +02:00
converse.rooms.open('group@muc.example.com')
2015-04-05 08:36:26 +02:00
2015-04-24 12:03:22 +02:00
To return an array of rooms, provide an array of room JIDs::
2015-04-05 08:36:26 +02:00
2015-04-24 12:03:22 +02:00
converse.rooms.open(['group1@muc.example.com', 'group2@muc.example.com'])
2015-04-05 08:36:26 +02:00
2015-04-24 12:03:22 +02:00
To setup a custom nickname when joining the room, provide the optional nick argument::
2015-04-05 08:36:26 +02:00
2015-04-16 06:23:13 +02:00
converse.rooms.open('group@muc.example.com', 'mycustomnick')
2015-04-05 08:36:26 +02:00
2015-02-11 15:02:04 +01:00
"settings" grouping
-------------------
This grouping allows you to get or set the configuration settings of converse.js.
get(key)
~~~~~~~~
Returns the value of a configuration settings. For example::
converse.settings.get("play_sounds"); // default value returned would be false;
set(key, value) or set(object)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Set one or many configuration settings. For example::
converse.settings.set("play_sounds", true);
or ::
converse.settings.set({
"play_sounds", true,
"hide_offline_users" true
});
Note, this is not an alternative to calling `` converse.initialize `` , which still needs
to be called. Generally, you'd use this method after converse.js is already
running and you want to change the configuration on-the-fly.
2014-12-07 00:53:17 +01:00
"tokens" grouping
-----------------
get
~~~
Returns a token, either the RID or SID token depending on what's asked for.
Example::
converse.tokens.get('rid')
"listen" grouping
-----------------
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::
2015-03-16 10:40:00 +01:00
converse.listen.on('message', function (event, messageXML) { ... });
2014-12-07 00:53:17 +01:00
* **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::
2015-03-16 10:40:00 +01:00
converse.listen.once('message', function (event, messageXML) { ... });
2014-12-07 00:53:17 +01:00
* **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::
2015-03-16 10:40:00 +01:00
converse.listen.not('message', function (event, messageXML) { ... });
2014-12-07 00:53:17 +01:00
Events
======
.. note :: see also the `"listen" grouping`_ API section above.
Event Types
-----------
Here are the different events that are emitted:
2015-03-18 11:33:26 +01:00
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| Event Type | When is it triggered? | Example |
+=================================+===================================================================================================+======================================================================================================+
| **initialized** | Once converse.js has been initialized. | `` converse.listen.on('initialized', function (event) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **ready** | After connection has been established and converse.js has got all its ducks in a row. | `` converse.listen.on('ready', function (event) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **reconnect** | After the connection has dropped. Converse.js will attempt to reconnect when not in prebind mode. | `` converse.listen.on('reconnect', function (event) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **message** | When a message is received. | `` converse.listen.on('message', function (event, messageXML) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **messageSend** | When a message will be sent out. | `` storage_memoryconverse.listen.on('messageSend', function (event, messageText) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **noResumeableSession** | When keepalive=true but there aren't any stored prebind tokens. | `` converse.listen.on('noResumeableSession', function (event) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **roster** | When the roster is updated. | `` converse.listen.on('roster', function (event, items) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **callButtonClicked** | When a call button (i.e. with class .toggle-call) on a chat box has been clicked. | `` converse.listen.on('callButtonClicked', function (event, connection, model) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **chatBoxOpened** | When a chat box has been opened. | `` converse.listen.on('chatBoxOpened', function (event, chatbox) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **chatRoomOpened** | When a chat room has been opened. | `` converse.listen.on('chatRoomOpened', function (event, chatbox) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **chatBoxClosed** | When a chat box has been closed. | `` converse.listen.on('chatBoxClosed', function (event, chatbox) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **chatBoxFocused** | When the focus has been moved to a chat box. | `` converse.listen.on('chatBoxFocused', function (event, chatbox) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **chatBoxToggled** | When a chat box has been minimized or maximized. | `` converse.listen.on('chatBoxToggled', function (event, chatbox) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **roomInviteSent** | After the user has sent out a direct invitation, to a roster contact, asking them to join a room. | `` converse.listen.on('roomInvite', function (event, 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.listen.on('roomInvite', function (event, roomview, invitee_jid, reason) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **statusChanged** | When own chat status has changed. | `` converse.listen.on('statusChanged', function (event, status) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **statusMessageChanged** | When own custom status message has changed. | `` converse.listen.on('statusMessageChanged', function (event, message) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **contactStatusChanged** | When a chat buddy's chat status has changed. | `` converse.listen.on('contactStatusChanged', function (event, buddy, status) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| **contactStatusMessageChanged** | When a chat buddy's custom status message has changed. | `` converse.listen.on('contactStatusMessageChanged', function (event, buddy, messageText) { ... }); `` |
+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
