Mercurial > prosody-wiki

annotate mod_archive.wiki @ 190:479655c59e6d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated wiki to reflect changes.
author maranda3985@gmail.com
date Fri, 22 Apr 2011 04:21:52 +0000
parents 5d350ab051f8
children 757684c251d9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
129
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
1 #summary XEP-0136: Message Archiving
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
2 #labels Stage-Beta
129
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
3
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
4 = Introduction =
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
5
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
6 Currently many XMPP clients save the messages locally and it's not convenient or even possible to retrieve the historical messages, especially when one switches the clients a lot.
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
7
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
8 So it will be much easier if the XMPP server supports server-side message archiving. In this case, the clients can retrieve archived messages anytime and anywhere. XMPP Extension Proposal XEP-0136 is defined for this purpose. This module is an implementation of [http://xmpp.org/extensions/xep-0136.html XEP-0136: Message Archiving].
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
9
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
10 = Details =
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
11
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
12 The server will have the ability to archive messages passing through.
129
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
13
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
14 = Usage =
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
15
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
16 First copy the module to the prosody plugins directory.
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
17
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
18 Then add "archive" to your modules_enabled list:
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
19 {{{
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
20 modules_enabled = {
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
21 -- ...
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
22 "privacy",
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
23 "archive",
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
24 -- ...
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
25 }}}
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
26
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
27 = Configuration =
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
28 || *Name* || *Description* || *Type* || *Default value* ||
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
29 || default_max || the maximum number of items to return when requesting collection list or archived messages || integer || 100 ||
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
30 || force_archiving || archive every message automatically, and do NOT consider the preferences || boolean || false ||
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
31 || auto_archiving_enabled || applied when no any preferences available || boolean || true ||
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
32
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
33
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
34 = Compatibility =
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
35 || 0.7.0 || Works ||
129
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
36
131
90f54b821254 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 130
diff changeset
37 = TODO =
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
38 * consider '`exactmatch`' attribute when do JID matching.
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
39 * return a `<feature-not-implemented/>` error when the client set the value of the '`save`' attribute to '`stream`'.