erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc (components/AP gateway): "repeat" and "noticed/like":

Browse source 
fix 370
This commit is contained in:
Goffi 2022-07-22 17:40:03 +02:00
commit 6bb76a2bd0
1 changed files with 27 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

27
doc/components.rst
View file

@ -662,6 +662,32 @@ messages (see above).
.. _XEP-0372 (References): https://xmpp.org/extensions/xep-0372.html
Repeat/Share/Reboost
~~~~~~~~~~~~~~~~~~~~
The repeat feature (also named "share", or "boost") which consist of republishing an item
of interest under our own account to make it visible to our subscribers, is done on the
XMPP side with `XEP-0277 § Repeating a Post`_, and on the AP side it's an ``Announce``
activity. Conversion is done in both directions and should be transparent to user.
.. _XEP-0277 § Repeating a Post: https://xmpp.org/extensions/xep-0277.html#repeat
Noticed/Like
~~~~~~~~~~~~
AP's ``Like`` activity is converted on the XMPP side to "`Pubsub Attachment`_", which is
currently a "protoXEP", i.e. a specification proposed as a standard (not yet reviewed by
`XMPP Council`_). ``Like`` is converted to ``noticed`` attachment, meaning that it used in
to indicate that something has been seen and taken into account, without really indication
if the content is liked or disliked (see Pubsub Attachment § Foreword: `"noticed" instead
of "like" or "favourite"`_ for the rational).
As usual, conversion is done in both ways.
.. _Pubsub Attachment: https://xmpp.org/extensions/inbox/pubsub-attachments.html
.. _XMPP Council: https://xmpp.org/about/xmpp-standards-foundation/
.. _"noticed" instead of "like" or "favourite": https://xmpp.org/extensions/inbox/pubsub-attachments.html#noticed-foreword
Using the Component (for developers)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -686,3 +712,4 @@ Louise can use the following command::
Note the double escaping, one for the shell argument, and the other to specify JSON
object.