Mercurial > libervia-backend
view doc/libervia-cli/pubsub_attachments.rst @ 4231:e11b13418ba6
plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation:
Implement XEP-0343: Signaling WebRTC Data Channels in Jingle. The current version of the
XEP (0.3.1) has no implementation and contains some flaws. After discussing this on xsf@,
Daniel (from Conversations) mentioned that they had a sprint with Larma (from Dino) to
work on another version and provided me with this link:
https://gist.github.com/iNPUTmice/6c56f3e948cca517c5fb129016d99e74 . I have used it for my
implementation.
This implementation reuses work done on Jingle A/V call (notably XEP-0176 and XEP-0167
plugins), with adaptations. When used, XEP-0234 will not handle the file itself as it
normally does. This is because WebRTC has several implementations (browser for web
interface, GStreamer for others), and file/data must be handled directly by the frontend.
This is particularly important for web frontends, as the file is not sent from the backend
but from the end-user's browser device.
Among the changes, there are:
- XEP-0343 implementation.
- `file_send` bridge method now use serialised dict as output.
- New `BaseTransportHandler.is_usable` method which get content data and returns a boolean
(default to `True`) to tell if this transport can actually be used in this context (when
we are initiator). Used in webRTC case to see if call data are available.
- Support of `application` media type, and everything necessary to handle data channels.
- Better confirmation message, with file name, size and description when available.
- When file is accepted in preflight, it is specified in following `action_new` signal for
actual file transfer. This way, frontend can avoid the display or 2 confirmation
messages.
- XEP-0166: when not specified, default `content` name is now its index number instead of
a UUID. This follows the behaviour of browsers.
- XEP-0353: better handling of events such as call taken by another device.
- various other updates.
rel 441
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 06 Apr 2024 12:57:23 +0200 |
| parents | 8b76caa89aa0 |
| children |
line wrap: on
line source
.. _libervia-cli_pubsub_attachments: ======================================================= pubsub/attachments: (Un)Attach Metadata to Pubsub Items ======================================================= ``attachments`` is a subcommand grouping all pubsub commands related to "pubsub attachments" specification. With them, you can (un)attach data to any pubsub item. This is notably used to handle data like saying if an item is (un)noticed, or add emoji reactions. get === Retrieve a list of all attached data to an item. By default all attachments of the item are returned, this can be filtered by using ``-j JIDS, --jid JIDS`` example ------- Louise check all attachments on her last blog post:: $ li pubsub attachments get -s louise@example.org -n urn:xmpp:microblog:0 -i some-news-acf0 set === Update or replace attachments. By default new attachments are updated, but if the ``-R, --replace`` is used, new attachments replace the whole former one where it make sense. For instance, ``-R`` doesn't change anything for ``noticed`` attachments, but it will replace all reactions (potentially with no reaction at all), where the default behaviour is to merge former and new reactions. Note that only specified attachments are affected, if unknown or unspecified attachments exist, they will stay unmodified. For now, only ``noticed`` (to say that an element has been seen and taken into account) and ``reactions`` (emojis to show emotion or other kind of reaction about something) are managed. ``-N [BOOLEAN], --noticed [BOOLEAN]`` takes on optional argument to say if the item is noticed or not. If the optional argument is not specified, if will be the same as if the ``true`` value was used. examples -------- Pierre wants to indicate to Louise that is has seen and he took into account her last blog post:: $ li pubsub attachments set -s louise@example.org -n urn:xmpp:microblog:0 -i some-news-acf0 -N Louise wants to react to Pierre blog post about night trains:: $ li pubsub attachments set -s pierre@example.net -n urn:xmpp:microblog:0 -i nigh-train-are-great-f120 -r 🚆🌜💤