Răsfoiți Sursa

Add docs on keepalive setting.

JC Brand 11 ani în urmă
părinte
comite
45875afd64
2 a modificat fișierele cu 11 adăugiri și 0 ștergeri
  1. 3 0
      docs/CHANGES.rst
  2. 8 0
      docs/source/index.rst

+ 3 - 0
docs/CHANGES.rst

@@ -4,6 +4,9 @@ Changelog
 0.8.1 (Unreleased)
 ------------------
 
+* Converse.js now has the ability to maintain sessions across page loads
+  (previously, the session tokens had to be handled externally and passed in).
+  See the `keepalive <https://conversejs.org/docs/html/index.html#keepalive`_ configuration setting. [jcbrand]
 * Allow changing of nickname in a chat room via /nick command. [jcbrand]
 * Allow a chat room user to be muted or unmuted with the /mute and /voice commands. [jcbrand]
 * Add a chat room toolbar button for toggling the list of participants. [jcbrand]

+ 8 - 0
docs/source/index.rst

@@ -932,6 +932,14 @@ Default:  ``false``
 
 If set to true, debugging output will be logged to the browser console.
 
+keepalive
+---------
+
+Default:    ``true``
+
+Determines whether Converse.js will maintain the chat session across page
+loads.
+
 message_carbons
 ---------------