From c1d48b6f2cf9556c22446e527dd89f08c2f61f11 Mon Sep 17 00:00:00 2001 From: JC Brand Date: Wed, 18 Mar 2015 11:33:26 +0100 Subject: [PATCH] Docs fix: converse.on should be converse.listen.on fixes #341 --- docs/source/development.rst | 82 ++++++++++++++++++------------------- 1 file changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/source/development.rst b/docs/source/development.rst index bceddb612..03a4f0575 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -440,44 +440,44 @@ Event Types 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 (event) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **ready** | After connection has been established and converse.js has got all its ducks in a row. | ``converse.on('ready', function (event) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **reconnect** | After the connection has dropped. Converse.js will attempt to reconnect when not in prebind mode. | ``converse.on('reconnect', function (event) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **message** | When a message is received. | ``converse.on('message', function (event, messageXML) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **messageSend** | When a message will be sent out. | ``converse.on('messageSend', function (event, messageText) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **noResumeableSession** | When keepalive=true but there aren't any stored prebind tokens. | ``converse.on('noResumeableSession', function (event) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **roster** | When the roster is updated. | ``converse.on('roster', function (event, items) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **callButtonClicked** | When a call button (i.e. with class .toggle-call) on a chat box has been clicked. | ``converse.on('callButtonClicked', function (event, connection, model) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **chatBoxOpened** | When a chat box has been opened. | ``converse.on('chatBoxOpened', function (event, chatbox) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **chatRoomOpened** | When a chat room has been opened. | ``converse.on('chatRoomOpened', function (event, chatbox) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **chatBoxClosed** | When a chat box has been closed. | ``converse.on('chatBoxClosed', function (event, chatbox) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **chatBoxFocused** | When the focus has been moved to a chat box. | ``converse.on('chatBoxFocused', function (event, chatbox) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **chatBoxToggled** | When a chat box has been minimized or maximized. | ``converse.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.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.on('roomInvite', function (event, roomview, invitee_jid, reason) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **statusChanged** | When own chat status has changed. | ``converse.on('statusChanged', function (event, status) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **statusMessageChanged** | When own custom status message has changed. | ``converse.on('statusMessageChanged', function (event, message) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **contactStatusChanged** | When a chat buddy's chat status has changed. | ``converse.on('contactStatusChanged', function (event, buddy, status) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| **contactStatusMessageChanged** | When a chat buddy's custom status message has changed. | ``converse.on('contactStatusMessageChanged', function (event, buddy, messageText) { ... });`` | -+---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ ++---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| 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) { ... });`` | ++---------------------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+