Mercurial > libervia-backend
comparison doc/libervia-cli/message.rst @ 3806:adebd8036b68
doc (cli/message): `retract` command
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 17 Jun 2022 15:50:15 +0200 |
parents | 267e4987b58b |
children | d6837db456fd |
comparison
equal
deleted
inserted
replaced
3805:33ab258df0de | 3806:adebd8036b68 |
---|---|
33 | 33 |
34 Send a ``normal`` message marked as French with a subject:: | 34 Send a ``normal`` message marked as French with a subject:: |
35 | 35 |
36 $ echo 'Bonjour, je vous écris avec « Libervia »' | li message send -l fr -t normal -S 'Ceci est un message de test' | 36 $ echo 'Bonjour, je vous écris avec « Libervia »' | li message send -l fr -t normal -S 'Ceci est un message de test' |
37 | 37 |
38 retract | |
39 ======= | |
40 | |
41 Retract a message, i.e. mark it as retracted in database, and send a retraction request to | |
42 original recipient. | |
43 | |
44 When a message is marked as retracted in database, it won't appear anymore or a hint | |
45 (commonly called *tombstone*) will be displayed instead (the behaviour depend of the | |
46 frontend that you're using). However, there is an option to archive retracted messages: | |
47 ``Privacy``/``retract_history``. This option is disabled by default, but if you set it | |
48 (e.g. with ``li param set``), the original message will be kept in metadata and may be | |
49 displayed if the frontend that you're using allows it. | |
50 | |
51 The ``message_id`` positional argument is the internal ID of the message (not an XMPP ID). | |
52 It may be displayed by some frontends. | |
53 | |
54 .. note:: | |
55 | |
56 It is not possible to be sure that a message will be retracted: once something is sent | |
57 through the network, any recipient can keep it, copy it, share it, etc. This is true for | |
58 Libervia/XMPP as for any software, decentralized or not. | |
59 | |
60 Retract send a retractation **request**, i.e. it asks to the recipient(s) client(s) to | |
61 hide or delete the message, but it's not possible to have a guarantee that nobody kept | |
62 a request. | |
63 | |
64 The message is also removed from database, except if the option | |
65 ``Privacy``/``retract_history`` is set (see above). | |
66 | |
67 example | |
68 ------- | |
69 | |
70 Retract message with ID ``1234-5678-9abc-def0``:: | |
71 | |
72 $ li message retract 1234-5678-9abc-def0 | |
73 | |
38 mam | 74 mam |
39 === | 75 === |
40 | 76 |
41 Query archives using MAM. | 77 Query archives using MAM. |
78 | |
42 This command allows you to check message archive kept on the server (i.e. not the local copy). | 79 This command allows you to check message archive kept on the server (i.e. not the local copy). |
43 You usually want to specify a starting point, and a number of message to retrieve. If too many messages | 80 You usually want to specify a starting point, and a number of message to retrieve. If too many messages |
44 are available, you'll have to use RSM commands to navigate through the results. | 81 are available, you'll have to use RSM commands to navigate through the results. |
45 | 82 |
46 examples | 83 examples |