Mercurial > libervia-backend
comparison doc/components.rst @ 3874:c2b292d30c66
doc (components/AP gateway): "repeat" and "noticed/like":
fix 370
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 22 Jul 2022 17:40:03 +0200 |
| parents | 9a53b513ae55 |
| children | 18ff4f75f0e6 |
comparison
equal
deleted
inserted
replaced
| 3873:8b76caa89aa0 | 3874:c2b292d30c66 |
|---|---|
| 660 | 660 |
| 661 To mention XMPP entities, your client must use XEP-0372 references directly. | 661 To mention XMPP entities, your client must use XEP-0372 references directly. |
| 662 | 662 |
| 663 .. _XEP-0372 (References): https://xmpp.org/extensions/xep-0372.html | 663 .. _XEP-0372 (References): https://xmpp.org/extensions/xep-0372.html |
| 664 | 664 |
| 665 Repeat/Share/Reboost | |
| 666 ~~~~~~~~~~~~~~~~~~~~ | |
| 667 | |
| 668 The repeat feature (also named "share", or "boost") which consist of republishing an item | |
| 669 of interest under our own account to make it visible to our subscribers, is done on the | |
| 670 XMPP side with `XEP-0277 § Repeating a Post`_, and on the AP side it's an ``Announce`` | |
| 671 activity. Conversion is done in both directions and should be transparent to user. | |
| 672 | |
| 673 .. _XEP-0277 § Repeating a Post: https://xmpp.org/extensions/xep-0277.html#repeat | |
| 674 | |
| 675 Noticed/Like | |
| 676 ~~~~~~~~~~~~ | |
| 677 | |
| 678 AP's ``Like`` activity is converted on the XMPP side to "`Pubsub Attachment`_", which is | |
| 679 currently a "protoXEP", i.e. a specification proposed as a standard (not yet reviewed by | |
| 680 `XMPP Council`_). ``Like`` is converted to ``noticed`` attachment, meaning that it used in | |
| 681 to indicate that something has been seen and taken into account, without really indication | |
| 682 if the content is liked or disliked (see Pubsub Attachment § Foreword: `"noticed" instead | |
| 683 of "like" or "favourite"`_ for the rational). | |
| 684 | |
| 685 As usual, conversion is done in both ways. | |
| 686 | |
| 687 .. _Pubsub Attachment: https://xmpp.org/extensions/inbox/pubsub-attachments.html | |
| 688 .. _XMPP Council: https://xmpp.org/about/xmpp-standards-foundation/ | |
| 689 .. _"noticed" instead of "like" or "favourite": https://xmpp.org/extensions/inbox/pubsub-attachments.html#noticed-foreword | |
| 690 | |
| 665 Using the Component (for developers) | 691 Using the Component (for developers) |
| 666 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 692 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 667 | 693 |
| 668 Publication of AP items can be tested using the following method (with can be accessed | 694 Publication of AP items can be tested using the following method (with can be accessed |
| 669 through the ``APSend`` bridge method, client is then replaced by the ``profile`` name, as | 695 through the ``APSend`` bridge method, client is then replaced by the ``profile`` name, as |
| 684 | 710 |
| 685 $ li debug bridge method -c APSend '"{\"node\": \"https://example.net/@pierre/106986412193109832\", \"content\": \"A lille hello from XMPP\"}","pierre\\40example.net@ap.example.org", "louise"' | 711 $ li debug bridge method -c APSend '"{\"node\": \"https://example.net/@pierre/106986412193109832\", \"content\": \"A lille hello from XMPP\"}","pierre\\40example.net@ap.example.org", "louise"' |
| 686 | 712 |
| 687 Note the double escaping, one for the shell argument, and the other to specify JSON | 713 Note the double escaping, one for the shell argument, and the other to specify JSON |
| 688 object. | 714 object. |
| 715 |