mike/biboumi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update the Archive documentation, regarding the previous commit

Browse Source
This commit is contained in:
louiz’
2017-08-27 22:37:55 +02:00
parent fcaffb9e77
commit e0d019696e
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/biboumi.1.rst
+12 -3
View File
@@ -383,14 +383,23 @@ History
Public channel messages are saved into archives, inside the database, unless Public channel messages are saved into archives, inside the database, unless
the `record_history` option is set to false by that user (see `Ad-hoc commands`). the `record_history` option is set to false by that user (see `Ad-hoc commands`).
Private messages (messages that are sent directly to a nickname, not a Private messages (messages that are sent directly to a nickname, not a
channel) are never stored in the database. When a channel is joined, biboumi channel) are never stored in the database.
sends the `max_history_length` messages found in the database as the MUC
history.
A channel history can be retrieved by using `Message archive management (MAM) A channel history can be retrieved by using `Message archive management (MAM)
<https://xmpp.org/extensions/xep-0313.htm>`_ on the channel JID. The results <https://xmpp.org/extensions/xep-0313.htm>`_ on the channel JID. The results
can be filtered by start and end dates. can be filtered by start and end dates.
When a channel is joined, if the client doesn’t specify any limit, biboumi
sends the `max_history_length` last messages found in the database as the
MUC history. If a client wants to only use MAM for the archives (because
it’s more convenient and powerful), it should request to receive no
history by using an attribute maxchars='0' or maxstanzas='0' as defined in
XEP 0045, and do a proper MAM request instead.
Note: the maxchars attribute is ignored unless its value is exactly 0.
Supporting it properly would be very hard and would introduce a lot of
complexity for almost no benefit.
For a given channel, each user has her or his own archive. The content of For a given channel, each user has her or his own archive. The content of
the archives are never shared, and thus a user can not use someone else’s the archives are never shared, and thus a user can not use someone else’s
archive to get the messages that they didn’t receive when they were offline. archive to get the messages that they didn’t receive when they were offline.