Document show_call_button option

This commit is contained in:
Pete Nicholls 2013-12-26 15:02:28 +13:00
parent 1d3aa9f450
commit 0b4fe330d6
2 changed files with 27 additions and 0 deletions

View File

@ -1,6 +1,11 @@
Changelog
=========
Unreleased
----------
* Option to display a call button in the chatbox toolbar, to allow third-party libraries to provide a calling feature. [Aupajo]
0.7.2 (2013-12-18)
------------------

View File

@ -813,6 +813,28 @@ the page with class *toggle-online-users*.
If this options is set to true, the controlbox will by default be shown upon
page load.
show_call_button
----------------
Default = ``false``
Enable to display a call button on the chatbox toolbar.
When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.
::
converse.on('onCallButtonClicked', function(event, data) {
console.log('Call button was clicked.');
console.log('Strophe connection is', data.connection);
console.log('Bare buddy JID is', data.model.get('jid'));
// ... Third-party library code ...
});
show_only_online_users
----------------------