Mercurial > libervia-backend
comparison doc/jp/pubsub_node_affiliations.rst @ 3041:72583524cfd3
doc (jp): jp commands are now fully documented:
rel 232
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Tue, 01 Oct 2019 22:49:06 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 3040:fee60f17ebac | 3041:72583524cfd3 |
|---|---|
| 1 .. _jp-pubsub_node_affiliations: | |
| 2 | |
| 3 ======================================================= | |
| 4 pubsub/node/affiliations: nodes affiliations management | |
| 5 ======================================================= | |
| 6 | |
| 7 ``affiliations`` is a subcommand handling the affiliations of a node (not to be confused | |
| 8 with ``pubsub affiliations`` which handle the affiliations of a PubSub service). | |
| 9 | |
| 10 get | |
| 11 === | |
| 12 | |
| 13 Retrieve entities affiliated to this node and their role. | |
| 14 | |
| 15 example | |
| 16 ------- | |
| 17 | |
| 18 Get affiliations of a node:: | |
| 19 | |
| 20 $ jp pubsub node affiliations get -n some_node | |
| 21 | |
| 22 set | |
| 23 === | |
| 24 | |
| 25 Set affiliation of an entity on a node. Affiliations are specified with ``-a JID | |
| 26 AFFILIATION`` argument. Check `XEP-0060 affiliations`_ for allowed values for | |
| 27 ``AFFILIATION``. Use ``none`` to remove an affiliation. | |
| 28 | |
| 29 .. _XEP-0060 affiliations: https://xmpp.org/extensions/xep-0060.html#affiliations | |
| 30 | |
| 31 example | |
| 32 ------- | |
| 33 | |
| 34 If we have a whitelisted node ``some_whitelisted_node``, we can allow | |
| 35 ``louise@example.net`` to publish on it (by setting her role as ``publisher``), and | |
| 36 ``pierre@example.net`` to access it (by setting his role as ``member``) using the | |
| 37 following command:: | |
| 38 | |
| 39 $ jp pubsub node affiliations set -n some_whitelisted_node -a louise@example.net | |
| 40 publisher -a pierre@example.net member |