1
0
mirror of https://github.com/moparisthebest/xeps synced 2024-11-21 08:45:04 -05:00

XEP-0060: Clarify behaviour and current usage of the 'pubsub#itemreply' option

This commit is contained in:
Matthew Wild 2023-03-22 12:38:57 +00:00 committed by Maxime “pep” Buquet
parent 958a4499db
commit 9067d145e1

View File

@ -58,6 +58,7 @@
<ul> <ul>
<li><p>Add data model informational text in Implementation Notes.</p></li> <li><p>Add data model informational text in Implementation Notes.</p></li>
<li><p>Provide a way for a PubSub service to tell a client when a node is full.</p></li> <li><p>Provide a way for a PubSub service to tell a client when a node is full.</p></li>
<li><p>Clarify behaviour and current usage of the 'pubsub#itemreply' option.</p></li>
<li><p>Fix spec approver</p></li> <li><p>Fix spec approver</p></li>
</ul> </ul>
</remark> </remark>
@ -2944,7 +2945,7 @@ And by opposing end them?
]]></example> ]]></example>
</section4> </section4>
<section4 topic='Item Publisher' anchor='publisher-publish-success-publisher'> <section4 topic='Item Publisher' anchor='publisher-publish-success-publisher'>
<p>If configured to do so, the service can include the publisher of the item when it generates event notifications.</p> <p>If configured to do so (see <link url='#impl-association'>Associating Events and Payloads with the Generating Entity</link>), the service can include the publisher of the item when it generates event notifications.</p>
<example caption='Service Notifies Subscribers'><![CDATA[ <example caption='Service Notifies Subscribers'><![CDATA[
<message from='pubsub.shakespeare.lit' to='francisco@denmark.lit' id='foo'> <message from='pubsub.shakespeare.lit' to='francisco@denmark.lit' id='foo'>
<event xmlns='http://jabber.org/protocol/pubsub#event'> <event xmlns='http://jabber.org/protocol/pubsub#event'>
@ -5674,13 +5675,15 @@ And by opposing end them?
<li>In the context of a group weblog, different users might publish to the weblog and replies might go to the publisher of an entry rather than to the weblog owner.</li> <li>In the context of a group weblog, different users might publish to the weblog and replies might go to the publisher of an entry rather than to the weblog owner.</li>
<li>In the context of an integrated pubsub and multi-user chat system, the node owner might be the room owner but all replies need to be sent to the room rather than to the owner.</li> <li>In the context of an integrated pubsub and multi-user chat system, the node owner might be the room owner but all replies need to be sent to the room rather than to the owner.</li>
</ul> </ul>
<p>Therefore we define the "itemreply" node configuration option, with two possible values:</p> <p>Therefore we define the "itemreply" node configuration option, with three possible values:</p>
<ul> <ul>
<li>"owner" (i.e., the node owner or an alias for the node owners)</li> <li>"owner" (i.e., the node owner or an alias for the node owners)</li>
<li>"publisher" (i.e., the item publisher)</li> <li>"publisher" (i.e., the item publisher)</li>
<li>"none"</li>
</ul> </ul>
<p>A node owner MUST NOT define more than one of these options.</p> <p>A node owner MUST NOT define more than one of these options.</p>
<p>An example is shown below.</p> <p>Interoperability note: As of March 2023, the value of "owner" is not widely supported in generic implementations, and clients may choose to avoid it. In contrast, the value of "none" was not specified in previous versions of this document but has been added retrospectively due to implementation support. Therefore, the primary use of the 'pubsub#itemreply' option is to allow node owners to determine whether the server will <link url='#publisher-publish-success-publisher'>include a 'publisher' attribute in items or not</link>.</p>
<p>The JID associated with an item is conveyed via the 'publisher' attribute on the &lt;item/&gt; element, as demonstrated in the below example:</p>
<example caption='Event notification with publisher JID'><![CDATA[ <example caption='Event notification with publisher JID'><![CDATA[
<message from='pubsub.shakespeare.lit' <message from='pubsub.shakespeare.lit'
to='bassanio@merchantofvenice.lit'> to='bassanio@merchantofvenice.lit'>