Mercurial > libervia-backend

view doc/jp/pubsub_node_subscriptions.rst @ 3324:b57b5e42e894

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
plugins invitation, invitation-file: adapt service JID and affiliation: if the user part of the service is missing while creating and invitation, it's added because using only the domain will lead to a different repository depending on the requester. In addition, the invitee is added to the repostiroy path as a member, to be sure he/she can access it.
author Goffi <goffi@goffi.org>
date Sat, 01 Aug 2020 16:24:03 +0200
parents 72583524cfd3
children
line wrap: on
line source

.. _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