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 (jp): jp commands are now fully documented:

Browse source 
rel 232
This commit is contained in:
Goffi 2019-10-01 22:49:06 +02:00
commit 7bfa63a751
1 changed files with 2976 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

43
doc/jp/pubsub_node_subscriptions.rst Normal file
View file

@ -0,0 +1,43 @@
.. _jp-pubsub_node_subscriptions:
========================================================
pubsub/node/affiliations: nodes subscriptions management
========================================================
``subscriptions`` is a subcommand handling the subscription to a node.
Those commands can only be used by an owner of the node.
get
===
Retrieve subscriptions to a node.
example
-------
Get subscription from ``some_node``::
$ jp pubsub node subscriptions get -n some_node
set
===
Set subscriptions to a node. Subscriptions are specified with ``-S JID [SUSBSCRIPTION]
[JID [SUSBSCRIPTION] ...], --subscription JID [SUSBSCRIPTION] [JID [SUSBSCRIPTION] ...]``
where ``JID`` is the jid of the entity to change subscription state, and ``SUBSCRIPTION``
is a subscription state (on of ``subscribed``, ``pending``, ``none``) as specified in
`XEP-0060 Subscription State`_. If ``SUBSCRIPTION`` is not specified, it default to
``subscribed``.
.. _XEP-0060 Subscription State: https://xmpp.org/extensions/xep-0060.html#substates
example
-------
Subscribe Louise with her new address at ``louise@example.org`` and remove her
subscription from old ``louise@example.com``::
$ jp pubsub node subscriptions set -n some_node -S louise@example.org subscribed louise@example.com none