view doc/jp/pubsub_node_affiliations.rst @ 3462:12dc234f698c

plugin invitation: pubsub invitations: - new Pubsub invitation plugin, to have a generic way to manage invitation on Pubsub based features - `invitePreflight` and `onInvitationPreflight` method can be implemented to customise invitation for a namespace - refactored events invitations to use the new plugin - a Pubsub invitation can now be for a whole node instead of a specific item - if invitation is for a node, a namespace can be specified to indicate what this node is about. It is then added in `extra` data - an element (domish.Element) can be added in `extra` data, it will then be added in the invitation - some code modernisation
author Goffi <goffi@goffi.org>
date Fri, 19 Feb 2021 15:50:22 +0100
parents 72583524cfd3
children
line wrap: on
line source

.. _jp-pubsub_node_affiliations:

=======================================================
pubsub/node/affiliations: nodes affiliations management
=======================================================

``affiliations`` is a subcommand handling the affiliations of a node (not to be confused
with ``pubsub affiliations`` which handle the affiliations of a PubSub service).

get
===

Retrieve entities affiliated to this node and their role.

example
-------

Get affiliations of a node::

  $ jp pubsub node affiliations get -n some_node

set
===

Set affiliation of an entity on a node. Affiliations are specified with ``-a JID
AFFILIATION`` argument. Check `XEP-0060 affiliations`_ for allowed values for
``AFFILIATION``. Use ``none`` to remove an affiliation.

.. _XEP-0060 affiliations: https://xmpp.org/extensions/xep-0060.html#affiliations

example
-------

If we have a whitelisted node ``some_whitelisted_node``, we can allow
``louise@example.net`` to publish on it (by setting her role as ``publisher``), and
``pierre@example.net`` to access it (by setting his role as ``member``) using the
following command::

  $ jp pubsub node affiliations set -n some_whitelisted_node -a louise@example.net
  publisher -a pierre@example.net member