Mercurial > libervia-backend

comparison doc/libervia-cli/pubsub_node_subscriptions.rst @ 3488:c80a0f864b5d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: updated doc following global renaming
author Goffi <goffi@goffi.org>
date Sun, 21 Mar 2021 18:23:58 +0100
parents doc/jp/pubsub_node_subscriptions.rst@72583524cfd3
children e597dbfbc4c6
comparison
equal deleted inserted replaced
3487:75427f0a5445 3488:c80a0f864b5d
1 .. _libervia-cli_pubsub_node_subscriptions:
2
3 ========================================================
4 pubsub/node/affiliations: nodes subscriptions management
5 ========================================================
6
7 ``subscriptions`` is a subcommand handling the subscription to a node.
8
9 Those commands can only be used by an owner of the node.
10
11 get
12 ===
13
14 Retrieve subscriptions to a node.
15
16 example
17 -------
18
19 Get subscription from ``some_node``::
20
21 $ li pubsub node subscriptions get -n some_node
22
23 set
24 ===
25
26 Set subscriptions to a node. Subscriptions are specified with ``-S JID [SUSBSCRIPTION]
27 [JID [SUSBSCRIPTION] ...], --subscription JID [SUSBSCRIPTION] [JID [SUSBSCRIPTION] ...]``
28 where ``JID`` is the jid of the entity to change subscription state, and ``SUBSCRIPTION``
29 is a subscription state (on of ``subscribed``, ``pending``, ``none``) as specified in
30 `XEP-0060 Subscription State`_. If ``SUBSCRIPTION`` is not specified, it default to
31 ``subscribed``.
32
33 .. _XEP-0060 Subscription State: https://xmpp.org/extensions/xep-0060.html#substates
34
35 example
36 -------
37
38 Subscribe Louise with her new address at ``louise@example.org`` and remove her
39 subscription from old ``louise@example.com``::
40
41 $ li pubsub node subscriptions set -n some_node -S louise@example.org subscribed louise@example.com none
42
43