From 0b4fe330d612356ef41ce8b7146543460f21f751 Mon Sep 17 00:00:00 2001 From: Pete Nicholls Date: Thu, 26 Dec 2013 15:02:28 +1300 Subject: [PATCH] Document show_call_button option --- docs/CHANGES.rst | 5 +++++ docs/source/index.rst | 22 ++++++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/docs/CHANGES.rst b/docs/CHANGES.rst index fd689727e..0a5a6e0e8 100644 --- a/docs/CHANGES.rst +++ b/docs/CHANGES.rst @@ -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) ------------------ diff --git a/docs/source/index.rst b/docs/source/index.rst index 03837cac2..14b027bc7 100644 --- a/docs/source/index.rst +++ b/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 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 ----------------------