Mercurial > libervia-backend

annotate doc/libervia-cli/pubsub_node_subscriptions.rst @ 4282:8da377040ba6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (encryption): update pubsub encryption specifications.
author Goffi <goffi@goffi.org>
date Sat, 13 Jul 2024 17:45:47 +0200
parents e597dbfbc4c6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3488
c80a0f864b5d doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents: 3041
diff changeset
1 .. _libervia-cli_pubsub_node_subscriptions:
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
2
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
3 ========================================================
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
4 pubsub/node/affiliations: nodes subscriptions management
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
5 ========================================================
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 ``subscriptions`` is a subcommand handling the subscription to a node.
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
8
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 Those commands can only be used by an owner of the node.
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
10
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
11 get
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 ===
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
13
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 Retrieve subscriptions to a node.
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
15
3771
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
16 If ``--public`` is used, only public subscriptions are retrieved (if target service
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
17 supports `XEP-0465 Public Pubsub Subscriptions`). Public subscriptions are accessible to
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
18 anybody, thus you can use this on a node even if you are not an owner of it (and thus
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
19 would not normally be allowed to retrieve subscriptions).
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
20
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
21 .. _XEP-0465 Public Pubsub Subscriptions: https://xmpp.org/extensions/inbox/pubsub-public-subscriptions.html
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
22
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
23 example
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
24 -------
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
25
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
26 Get subscription from ``some_node``::
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
27
3488
c80a0f864b5d doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents: 3041
diff changeset
28 $ li pubsub node subscriptions get -n some_node
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
29
3771
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
30 Retrieve public subscribers to the blog of Louise::
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
31
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
32 $ li pubsub node subscriptions get --public -s louise@example.org -n urn:xmpp:microblog:0
e597dbfbc4c6 doc (cli/pubsub): document new `--public` flags:
Goffi <goffi@goffi.org>
parents: 3488
diff changeset
33
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 set
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
35 ===
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
36
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
37 Set subscriptions to a node. Subscriptions are specified with ``-S JID [SUSBSCRIPTION]
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
38 [JID [SUSBSCRIPTION] ...], --subscription JID [SUSBSCRIPTION] [JID [SUSBSCRIPTION] ...]``
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
39 where ``JID`` is the jid of the entity to change subscription state, and ``SUBSCRIPTION``
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
40 is a subscription state (on of ``subscribed``, ``pending``, ``none``) as specified in
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
41 `XEP-0060 Subscription State`_. If ``SUBSCRIPTION`` is not specified, it default to
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
42 ``subscribed``.
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
43
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
44 .. _XEP-0060 Subscription State: https://xmpp.org/extensions/xep-0060.html#substates
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
45
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
46 example
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
47 -------
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
48
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
49 Subscribe Louise with her new address at ``louise@example.org`` and remove her
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
50 subscription from old ``louise@example.com``::
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
51
3488
c80a0f864b5d doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents: 3041
diff changeset
52 $ li pubsub node subscriptions set -n some_node -S louise@example.org subscribed louise@example.com none
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
53
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
54