2
0
Эх сурвалжийг харах

Document show_call_button option

Pete Nicholls 11 жил өмнө
parent
commit
0b4fe330d6

+ 5 - 0
docs/CHANGES.rst

@@ -1,6 +1,11 @@
 Changelog
 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)
 0.7.2 (2013-12-18)
 ------------------
 ------------------
 
 

+ 22 - 0
docs/source/index.rst

@@ -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
 If this options is set to true, the controlbox will by default be shown upon
 page load.
 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
 show_only_online_users
 ----------------------
 ----------------------