Participants node clarification

This commit is contained in:
Steve Kille 2017-04-03 11:26:47 +01:00 committed by Sam Whited
parent d17de7d7c4
commit 69919545c2
1 changed files with 32 additions and 11 deletions

View File

@ -43,6 +43,8 @@
<remark><p>
Fix xmpp:nodes typos;
Remove namespace references in Info/Config nodes;
Modify Participant and JID Map syntaxes;
Clarifications on subscription to participants node and using this to receive Nick changes;
</p></remark>
</revision>
<revision>
@ -488,14 +490,17 @@ This approach enables flexible support of multiple clients for a MIX channel pa
</p>
<p>
When a user joins a channel, the user's bare JID is added to the participants node by the MIX service. When a user leaves a channel, they are removed from the participants node. The participants node MUST NOT be directly modified using pubsub.
This node MAY be subscribed to for jid-visible channels that permit subscription to this node - this will allow users to see changes to the channel participants.
</p>
<p>
Users MAY subscribe to and read information this node, when permitted by the channel. Standard PubSub access will allow a full list of participants and associated nicks to be determined. By subscribing to the node, a user will be informed of changes to the Participants Node.
</p>
<p>The participants node is OPTIONAL. If the Participants Node is not used, information on channel participants is not shared. If there is no participants node, the access control value 'participants' MUST NOT be used. The Participants node is a permanent node with one item per participant.</p>
<example caption="Value of Participants Node"><![CDATA[
<items node='urn:xmpp:mix:nodes:participants'>
<item id='123456#coven@mix.shakespeare.example'>
<participant xmlns='urn:xmpp:mix:0'
nick='thirdwitch'/>
<participant xmlns='urn:xmpp:mix:0'>
<nick>thirdwitch</nick>
</participant>
</item>
</items>
]]></example>
@ -508,8 +513,9 @@ This approach enables flexible support of multiple clients for a MIX channel pa
<example caption="Value of JID Map Node"><![CDATA[
<items node='urn:xmpp:mix:nodes:jidmap'>
<item id='123456#coven@mix.shakespeare.example'>
<participant xmlns='urn:xmpp:mix:0'
jid='hecate@mix.shakespeare.example'/>
<participant xmlns='urn:xmpp:mix:0'>
<jid>hecate@mix.shakespeare.example</jid>
</participant>
</item>
</items>
]]></example>
@ -885,8 +891,16 @@ This approach enables flexible support of multiple clients for a MIX channel pa
type='result'>
<pubsub xlns='http://jabber.org/protocol/pubsub'>
<items node='urn:xmpp:mix:nodes:participants'>
<item jid='123456#coven@mix.shakespeare.example' nick='thirdwitch'>
<item jid='87123#coven@mix.shakespeare.example' nick='top witch'>
<item id='123456#coven@mix.shakespeare.example'>
<participant xmlns='urn:xmpp:mix:0'>
<nick>thirdwitch</nick>
</participant>
</item>
<item id='87123#coven@mix.shakespeare.example'>
<participant xmlns='urn:xmpp:mix:0'>
<nick>top witch</nick>
</participant>
</item>
</items>
</pubsub>
<items>
@ -1396,6 +1410,11 @@ This approach enables flexible support of multiple clients for a MIX channel pa
</iq>
]]></example>
<p>On success, the service informs the user of its nick. MIX SHOULD apply the "nickname" profile of the PRECIS OpaqueString class, as defined in &rfc7700; to the requested nick. This means that nick that is issued might be different from the nick that was requested.</p>
<p>
When an Nick is assigned, the MIX server MUST update the Participants Node in the channel to reflect this change. Any users subscribed to this node will be notified of the change of Nick.
</p>
<p>The following example shows an example of reporting successful Nick assignment.</p>
<example caption="Service Returns User of Nick"><![CDATA[
<iq type='result'
to='mix.shakespeare.example'
@ -1511,8 +1530,9 @@ This approach enables flexible support of multiple clients for a MIX channel pa
<pubsub xlns='http://jabber.org/protocol/pubsub'>
<items node='urn:xmpp:mix:nodes:jidmap'>
<item id='123456#coven@mix.shakespeare.example'>
<participant xmlns='urn:xmpp:mix:0'
jid='hecate@mix.shakespeare.example'/>
<participant xmlns='urn:xmpp:mix:0'>
<jid>hecate@mix.shakespeare.example<jid/>
</participant>
</item>
</items>
</pubsub>
@ -1552,8 +1572,9 @@ This approach enables flexible support of multiple clients for a MIX channel pa
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='urn:xmpp:mix:nodes:jidmap'>
<item id='123456#coven@mix.shakespeare.example'>
<participant xmlns='urn:xmpp:mix:0'
jid='hecate@mix.shakespeare.example'/>
<participant xmlns='urn:xmpp:mix:0'>
<jid>hecate@mix.shakespeare.example<jid/>
</participant>
</item>
</items>
</event>