f66f602df2
`--public` option is documented for `subscribe`, `subscriptions` and `node subscriptions get`, with examples. A warning has been added to show explicitely the privacy implication of using `--public` with `subscribe`. rel 365
54 lines
1.8 KiB
ReStructuredText
54 lines
1.8 KiB
ReStructuredText
.. _libervia-cli_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.
|
|
|
|
If ``--public`` is used, only public subscriptions are retrieved (if target service
|
|
supports `XEP-0465 Public Pubsub Subscriptions`). Public subscriptions are accessible to
|
|
anybody, thus you can use this on a node even if you are not an owner of it (and thus
|
|
would not normally be allowed to retrieve subscriptions).
|
|
|
|
.. _XEP-0465 Public Pubsub Subscriptions: https://xmpp.org/extensions/inbox/pubsub-public-subscriptions.html
|
|
|
|
example
|
|
-------
|
|
|
|
Get subscription from ``some_node``::
|
|
|
|
$ li pubsub node subscriptions get -n some_node
|
|
|
|
Retrieve public subscribers to the blog of Louise::
|
|
|
|
$ li pubsub node subscriptions get --public -s louise@example.org -n urn:xmpp:microblog:0
|
|
|
|
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``::
|
|
|
|
$ li pubsub node subscriptions set -n some_node -S louise@example.org subscribed louise@example.com none
|
|
|
|
|