Administration of Allowed/Banned

This commit is contained in:
Steve Kille 2016-11-04 09:51:31 +00:00 committed by Sam Whited
parent 8f8c2ad8b3
commit 60c7272ba2
1 changed files with 72 additions and 9 deletions

View File

@ -439,9 +439,8 @@
<example caption="Allowed Node"><![CDATA[
<items node='urn:xmpp:mix:nodes:allowed'>
<item id='@shakespeare.lit'>
<item id='alice@wonderland.lit'>
</item>
<item id='@shakespeare.lit'/>
<item id='alice@wonderland.lit'/>
</items>
]]></example>
</section3>
@ -455,9 +454,8 @@
<example caption="Banned Node"><![CDATA[
<items node='urn:xmpp:mix:nodes:banned'>
<item id='lear@shakespeare.lit'>
<item id='macbeth@shakespeare.lit'>
</item>
<item id='lear@shakespeare.lit'/>
<item id='macbeth@shakespeare.lit'/>
</items>
]]></example>
</section3>
@ -1939,17 +1937,82 @@ A client creates a channel by sending a simple request to the MIX service. A c
<section3 topic='Controlling Channel Partipcipants' anchor='usecase-admin-participants'>
<p>
Owners and Administrators may control which users can participate in a channel by use of Allowed and Banned lists.
Allowed and Banned lists may be read by PubSub query of the Banned and Allowed Nodes.
Owners and Administrators may control which users can participate in a channel by use of Allowed and Banned lists using PubSub. These operations follow &xep0060; which sets out detailed protocol use and error handling.
Allowed and Banned lists may be read by PubSub get of the Banned and Allowed Nodes. This operation may be used by users as controlled by 'Allowed Node Subscription' and 'Banned Node Subscription' configuration node options (default Administrators).
</p>
<example caption="Client Reads Allowed Node" ><![CDATA[
*** AUTHOR TBS
<iq from='hag66@shakespeare.example/intibo24'
id='lx09df27'
to='mix.shakespeare.example'
type='get'>
<pubsub xlns='http://jabber.org/protocol/pubsub'>
<items node= 'urn:xmpp:mix:nodes:allowed'/>
</pubsub>
</iq>
<iq from='mix.shakespeare.example'
id='lx09df27'
to='hag66@shakespeare.example/intibo24'
type='result'>
<pubsub xlns='http://jabber.org/protocol/pubsub'>
<items node= 'urn:xmpp:mix:nodes:allowed'>
<item id='@shakespeare.lit'/>
<item id='alice@wonderland.lit'/>
</items>
</pubsub>
</iq>
]]></example>
<p>
JIDs can be added to the Allowed and Banned nodes by a pubsub set command. This is used to add one item to a node.
</p>
<example caption="Client Adds a JID to the Allowed Node" ><![CDATA[
<iq from='hag66@shakespeare.example/intibo24'
id='lx09df27'
to='mix.shakespeare.example'
type='set'>
<pubsub xlns='http://jabber.org/protocol/pubsub'>
<publish node= 'urn:xmpp:mix:nodes:allowed'>
<item id='@marlow.lit'/>
</items>
</pubsub>
</iq>
<iq from='mix.shakespeare.example'
id='lx09df27'
to='hag66@shakespeare.example/intibo24'
type='result'>
<pubsub xlns='http://jabber.org/protocol/pubsub'/>
</iq>
]]></example>
<p>
JIDs can be removed from the Allowed and Banned nodes by pubsub retract command.
</p>
</section3>
<example caption="Client Removes a JID to the Banned Node" ><![CDATA[
<iq from='hag66@shakespeare.example/intibo24'
id='lx09df27'
to='mix.shakespeare.example'
type='set'>
<pubsub xlns='http://jabber.org/protocol/pubsub'>
<retract node= 'urn:xmpp:mix:nodes:banned'>
<item id='lear@shakespeare.lit'/>
</items>
</pubsub>
</iq>
<iq from='mix.shakespeare.example'
id='lx09df27'
to='hag66@shakespeare.example/intibo24'
type='result'>
<pubsub xlns='http://jabber.org/protocol/pubsub'/>
</iq>
]]></example>
<section3 topic='Removing a User From a Channel (Kicking)' anchor='usecase-admin-kick'>