Mercurial > prosody-modules

comparison mod_map/README.md @ 5975:fe081789f7b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parents mod_map/README.markdown@d31fa28d9482
children
comparison
equal deleted inserted replaced
5974:5a65a632d5b9 5975:fe081789f7b5
1 ---
2 labels:
3 - 'Stage-Experimental'
4 summary: Prototype MAM summary
5 ---
6
7 This is a prototype for an experimental archive summary API recently
8 added in [Prosody trunk](https://hg.prosody.im/trunk/rev/2c5546cc5c70).
9
10 # Protocol
11
12 ::: {.alert .alert-danger}
13 This is not a finished protocol, but a prototype meant for testing.
14 :::
15
16 A basic query:
17
18 ``` {.xml}
19 <iq id="lx7" type="get">
20 <summary xmlns="xmpp:prosody.im/mod_map"/>
21 </iq>
22 ```
23
24 Answered like:
25
26 ``` {.xml}
27 <iq type="result" id="lx7">
28 <summary xmlns="xmpp:prosody.im/mod_map">
29 <item jid="juliet@capulet.lit">
30 <count>3</count>
31 <start>2019-02-25T15:48:00+0100</start>
32 <end>2019-08-23T01:39:50+02:00</end>
33 <body>O Romeo, Romeo! wherefore art thou Romeo?</body>
34 </item>
35 </summary>
36 </iq>
37 ```
38
39 It can also take dataform and RSM parameters similar to a [filtered MAM
40 query](https://xmpp.org/extensions/xep-0313.html#filter).
41
42 E.g if the last message you received had an id `09af3-cc343-b409f` then
43 the following query would tell you who sent you messages since:
44
45 ``` {.xml}
46 <iq id="lx8" type="get">
47 <summary xmlns="xmpp:prosody.im/mod_map">
48 <set xmlns="http://jabber.org/protocol/rsm">
49 <max>10</max>
50 <after>09af3-cc343-b409f</after>
51 </set>
52 </summary>
53 </iq>
54 ```