mirror of https://github.com/moparisthebest/xeps
Change config & info management to directly use PubSub
This commit is contained in:
Steve Kille
parent
d9b93f51aa
commit
b5e0ea2ef6
52
xep-0369.xml
52
xep-0369.xml
|
|
@ -1705,20 +1705,23 @@ A client creates a channel by sending a simple request to the MIX service. A c
|
|||
</p>
|
||||
</section3>
|
||||
<section3 topic='Modifying Channel Information' anchor='usecase-admin-information'>
|
||||
<p>Authorized users, typically owners and sometimes administrators, may modify the channel information. The client MAY issue a get command to obtain a form that will facilitate update of the information node. The values in the form show current values, which be defaults or may have been explicitly set. In the following example, the channel name was previously set, but other values were not. </p>
|
||||
<p>Authorized users, typically owners and sometimes administrators, may modify the channel information. The client MAY issue a pubsub get command to obtain a form that will facilitate update of the information node. The values in the form show current values, which be defaults or may have been explicitly set. In the following example, the channel name was previously set, but other values were not. </p>
|
||||
<example caption="Getting Information Form" ><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/intibo24'
|
||||
id='lx09df27'
|
||||
to='mix.shakespeare.example'
|
||||
type='get'>
|
||||
<info xmlns='urn:xmpp:mix:0'/>
|
||||
<pubsub xmlns='http://jabber.org/protocol/'>
|
||||
<items node='urn:xmpp:mix:nodes:info'/>
|
||||
</pubsub>
|
||||
</iq>
|
||||
|
||||
<iq from='mix.shakespeare.example'
|
||||
id='lx09df27'
|
||||
to='hag66@shakespeare.example/intibo24'
|
||||
type='result'>
|
||||
<info xmlns='urn:xmpp:mix:0'/>
|
||||
<pubsub xmlns='http://jabber.org/protocol/'>
|
||||
<items node='urn:xmpp:mix:nodes:info'>
|
||||
<x xmlns='jabber:x:data' type='form'>
|
||||
<field var='FORM_TYPE' type='hidden'>
|
||||
<value>urn:xmpp:mix:0</value>
|
||||
|
|
@ -1736,16 +1739,18 @@ A client creates a channel by sending a simple request to the MIX service. A c
|
|||
label='Channel Administrative Contact'
|
||||
var='Contact'/>
|
||||
</x>
|
||||
</info>
|
||||
</items>
|
||||
</pubsub>
|
||||
</iq>
|
||||
]]></example>
|
||||
<p> Updating the information node is done using a set command of type info. The MIX channel MUST update the fields with values provided, leaving other fields unchanged. The result returns the id used in the information node item, which is the date/time of the modification. </p>
|
||||
<p> Updating the information node is done using a pubsub set command. The MIX channel MUST update the fields with values provided, leaving other fields unchanged. The result returns the id used in the information node item, which is the date/time of the modification. </p>
|
||||
<example caption="Modifying Channel Information" ><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/intibo24'
|
||||
id='lx09df27'
|
||||
to='mix.shakespeare.example'
|
||||
type='set'>
|
||||
<info xmlns='urn:xmpp:mix:0'>
|
||||
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
||||
<publish node='urn:xmpp:mix:nodes:info'>
|
||||
<x xmlns='jabber:x:data' type='submit'>
|
||||
<field var='FORM_TYPE' type='hidden'>
|
||||
<value>urn:xmpp:mix:0</value>
|
||||
|
|
@ -1760,32 +1765,40 @@ A client creates a channel by sending a simple request to the MIX service. A c
|
|||
<value>greymalkin@shakespeare.lit</value>
|
||||
</field>
|
||||
</x>
|
||||
</info>
|
||||
</publish>
|
||||
</pubsub>
|
||||
</iq>
|
||||
|
||||
<iq from='mix.shakespeare.example'
|
||||
id='lx09df27'
|
||||
to='hag66@shakespeare.example/intibo24'
|
||||
type='result'>
|
||||
<info id='2016-05-30T09:00:00' xmlns='urn:xmpp:mix:0'/>
|
||||
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
||||
<publish node='urn:xmpp:mix:nodes:info'>
|
||||
<item id='2016-05-30T09:00:00' xmlns='urn:xmpp:mix:0'/>
|
||||
</publish>
|
||||
</pubsub>
|
||||
</iq>
|
||||
]]></example>
|
||||
</section3>
|
||||
<section3 topic='Modifying Channel Configuration' anchor='usecase-admin-information'>
|
||||
<p>Channel owners may modify the channel configuration. The client MAY issue a get command "config" to obtain a form that will facilitate update of the configuration node. Other clients MAY be authorized to use this command to see the channel configuration, but only owners may update the configuration. The values in the form show current values, which be defaults or may have been explicitly set. The following example shows a short form returned to illustrate the syntax. A typical configuration form will be much larger with many fields. </p>
|
||||
<p>Channel owners may modify the channel configuration. The client MAY issue a pubsub get command to obtain a form that will facilitate update of the configuration node. Other clients MAY be authorized to use this command to see the channel configuration, but only owners may update the configuration. The values in the form show current values, which be defaults or may have been explicitly set. The following example shows a short form returned to illustrate the syntax. A typical configuration form will be much larger with many fields. </p>
|
||||
<example caption="Getting Configuration Form" ><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/intibo24'
|
||||
id='lx09df27'
|
||||
to='mix.shakespeare.example'
|
||||
type='get'>
|
||||
<config xmlns='urn:xmpp:mix:0'/>
|
||||
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
||||
<items node='urn:xmpp:mix:nodes:config'/>
|
||||
</pubsub>
|
||||
</iq>
|
||||
|
||||
<iq from='mix.shakespeare.example'
|
||||
id='lx09df27'
|
||||
to='hag66@shakespeare.example/intibo24'
|
||||
type='result'>
|
||||
<config xmlns='urn:xmpp:mix:0'/>
|
||||
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
||||
<items xmlns='urn:xmpp:mix:0' node='urn:xmpp:mix:nodes:config'>
|
||||
<x xmlns='jabber:x:data' type='form'>
|
||||
<field var='FORM_TYPE' type='hidden'>
|
||||
<value>urn:xmpp:mix:0</value>
|
||||
|
|
@ -1795,16 +1808,18 @@ A client creates a channel by sending a simple request to the MIX service. A c
|
|||
label='Channel Administrator'
|
||||
var='Administrator'/>
|
||||
</x>
|
||||
</config>
|
||||
</items>
|
||||
</pubsub>
|
||||
</iq>
|
||||
]]></example>
|
||||
<p> Updating the information node is done using a set command of type config. The MIX channel MUST update the fields with values provided, leaving other fields unchanged. The result returns the id used in the configuration node item, which is the date/time of the modification. </p>
|
||||
<p> Updating the information node is done using a pubsub set command. The MIX channel MUST update the fields with values provided, leaving other fields unchanged. The result returns the id used in the configuration node item, which is the date/time of the modification. </p>
|
||||
<example caption="Modifying Channel Configuration" ><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/intibo24'
|
||||
id='lx09df27'
|
||||
to='mix.shakespeare.example'
|
||||
type='set'>
|
||||
<config xmlns='urn:xmpp:mix:0'>
|
||||
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
||||
<publish node='urn:xmpp:mix:nodes:config'>
|
||||
<x xmlns='jabber:x:data' type='submit'>
|
||||
<field var='FORM_TYPE' type='hidden'>
|
||||
<value>urn:xmpp:mix:0</value>
|
||||
|
|
@ -1825,14 +1840,19 @@ A client creates a channel by sending a simple request to the MIX service. A c
|
|||
<value>true</value>
|
||||
</field>
|
||||
</x>
|
||||
</config>
|
||||
</publish>
|
||||
</pubsub>
|
||||
</iq>
|
||||
|
||||
<iq from='mix.shakespeare.example'
|
||||
id='lx09df27'
|
||||
to='hag66@shakespeare.example/intibo24'
|
||||
type='result'>
|
||||
<config id='2016-05-30T09:00:00' xmlns='urn:xmpp:mix:0'/>
|
||||
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
||||
<publish node='urn:xmpp:mix:nodes:config'>
|
||||
<item id='2016-05-30T09:00:00' xmlns='urn:xmpp:mix:0'/>
|
||||
</publish>
|
||||
</pubsub>
|
||||
</iq>
|
||||
]]></example>
|
||||
</section3>
|
||||
|
|
|
|||
Loading…
Reference in New Issue