Mercurial > libervia-backend

comparison doc/components.rst @ 3827:23b53ac87e0f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (components/AP): identity and avatar: fix 368
author Goffi <goffi@goffi.org>
date Wed, 29 Jun 2022 14:23:16 +0200
parents 29380ef68dbe
children 9a53b513ae55
comparison
equal deleted inserted replaced
3826:81c79b7cafa7 3827:23b53ac87e0f
582 many clients support it, and you can use Libervia CLI to do it from command-line (see 582 many clients support it, and you can use Libervia CLI to do it from command-line (see
583 :ref:`libervia-cli_blocking`). 583 :ref:`libervia-cli_blocking`).
584 584
585 .. _XEP-0191 (Blocking Command): https://xmpp.org/extensions/xep-0191.html 585 .. _XEP-0191 (Blocking Command): https://xmpp.org/extensions/xep-0191.html
586 586
587 Identity and Avatar
588 ~~~~~~~~~~~~~~~~~~~
589
590 The gateway does the conversion between XMPP identity and AP actor metadata.
591
592 XMPP "identity" is actually a compilaton of data coming from various locations and in
593 particular `XEP-0292 (vCard4 Over XMPP)`_. In those data, vCard's ``nickname`` (first
594 found) is used as AP ``name`` field, and vCard's ``note`` is used as AP's ``summary``
595 (it's generally a self-description of users).
596
597 For avatars, `XEP-0084 (User Avatar)`_ is used (and actor's ``icon`` field is used on AP
598 side). Avatars are downloaded the first time that they are requested, and kept in cache
599 for future requests.
600
601 Even if XEP-0292 and XEP-0084 are the main XEPs used, Libervia checks various locations,
602 and other extensions like `XEP-0054 (vcard-temp)`_ may be used as fallback.
603
604 .. _XEP-0292 (vCard4 Over XMPP): https://xmpp.org/extensions/xep-0292.html
605 .. _XEP-0084 (User Avatar): https://xmpp.org/extensions/xep-0084.html
606 .. _XEP-0054 (vcard-temp): https://xmpp.org/extensions/xep-0054.html
607
587 Using the Component (for developers) 608 Using the Component (for developers)
588 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 609 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
589 610
590 Publication of AP items can be tested using the following method (with can be accessed 611 Publication of AP items can be tested using the following method (with can be accessed
591 through the ``APSend`` bridge method, client is then replaced by the ``profile`` name, as 612 through the ``APSend`` bridge method, client is then replaced by the ``profile`` name, as