comparison doc/libervia-cli/pubsub_node_subscriptions.rst @ 3771:e597dbfbc4c6

doc (cli/pubsub): document new `--public` flags: `--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
author Goffi <goffi@goffi.org>
date Fri, 13 May 2022 19:32:06 +0200
parents c80a0f864b5d
children
comparison
equal deleted inserted replaced
3770:f31113777881 3771:e597dbfbc4c6
11 get 11 get
12 === 12 ===
13 13
14 Retrieve subscriptions to a node. 14 Retrieve subscriptions to a node.
15 15
16 If ``--public`` is used, only public subscriptions are retrieved (if target service
17 supports `XEP-0465 Public Pubsub Subscriptions`). Public subscriptions are accessible to
18 anybody, thus you can use this on a node even if you are not an owner of it (and thus
19 would not normally be allowed to retrieve subscriptions).
20
21 .. _XEP-0465 Public Pubsub Subscriptions: https://xmpp.org/extensions/inbox/pubsub-public-subscriptions.html
22
16 example 23 example
17 ------- 24 -------
18 25
19 Get subscription from ``some_node``:: 26 Get subscription from ``some_node``::
20 27
21 $ li pubsub node subscriptions get -n some_node 28 $ li pubsub node subscriptions get -n some_node
29
30 Retrieve public subscribers to the blog of Louise::
31
32 $ li pubsub node subscriptions get --public -s louise@example.org -n urn:xmpp:microblog:0
22 33
23 set 34 set
24 === 35 ===
25 36
26 Set subscriptions to a node. Subscriptions are specified with ``-S JID [SUSBSCRIPTION] 37 Set subscriptions to a node. Subscriptions are specified with ``-S JID [SUSBSCRIPTION]