xeps/xep-0194.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
  <!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
  <title>User Chatting</title>
  <abstract>This document defines an XMPP protocol extension for communicating information about the chatrooms a user visits.</abstract>
  &LEGALNOTICE;
  <number>0194</number>
  <status>Experimental</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XMPP IM</spec>
    <spec>XEP-0060</spec>
    <spec>XEP-0163</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>chatting</shortname>
  &stpeter;
  <revision>
    <version>0.1</version>
    <date>2006-08-30</date>
    <initials>psa</initials>
    <remark><p>Initial version.</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2006-08-28</date>
    <initials>psa</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>&xep0060; and &xep0163; can be used to publish a wide variety of "extended presence" information about users. This document specifies an extended presence payload format that communicates information about the chatrooms a user visits. This information may be of interest to a user's contacts and can also be used in social networking applications.</p>
</section1>
<section1 topic='Protocol' anchor='protocol'>
  <section2 topic='Container Element and Child Elements' anchor='protocol-elements'>
    <p>Information about chatrooms is provided by the user (or automated integration with Jabber, IRC, or other systems) and is propagated on the network by the user's client. The information container for chatting data is a &lt;room/&gt; element that is qualified by the 'http://jabber.org/protocol/chatting' namespace. The chatting information itself is provided as the XML character data of the following children of the &lt;room/&gt; element:</p>
    <table caption='Child Elements'>
      <tr>
        <th>Element</th>
        <th>Description</th>
        <th>Example</th>
        <th>Datatype</th>
        <th>Inclusion</th>
      </tr>
      <tr>
        <td>name</td>
        <td>The name of the chatroom</td>
        <td>jdev</td>
        <td>xs:string</td>
        <td>OPTIONAL</td>
      </tr>
      <tr>
        <td>topic</td>
        <td>The current topic of discussion in the room</td>
        <td>Whiteboard protocol meeting</td>
        <td>xs:string</td>
        <td>OPTIONAL</td>
      </tr>
      <tr>
        <td>uri</td>
        <td>A URI for the room (this SHOULD be an XMPP URI in accordance with &rfc4622; but MAY use some other URI scheme, such as the irc: scheme)</td>
        <td>xmpp:jdev@conference.jabber.org</td>
        <td>xs:anyURI</td>
        <td>REQUIRED</td>
      </tr>
    </table>
    <p>NOTE: The datatypes specified above are defined in &w3xmlschema2;.</p>
  </section2>
  <section2 topic='Transport Mechanism' anchor='protocol-transport'>
    <p>When a user joins a room, its client may publish that fact to a special pubsub or PEP node (if a PEP node, the NodeID is "http://jabber.org/protocol/chatting"). The chatting information SHOULD be communicated and transported by means of the <cite>XEP-0060</cite> protocol, especially the subset specified in <cite>XEP-0163</cite> (as shown in the following examples). Because chatroom information is not pure presence information and can change independently of the user's availability, it SHOULD NOT be provided as an extension to the &PRESENCE; stanza type.</p>
    <example caption='User Publishes Chatting Information'><![CDATA[
<iq type='set' from='stpeter@jabber.org/work' id='chatting1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='http://jabber.org/protocol/chatting'>
      <item id='1b395148292c0b0ab3a83bb2c22909bf83d2a80b'>
        <room xmlns='http://jabber.org/protocol/chatting'>
          <name>jdev</name>
          <uri>xmpp:jdev@conference.jabber.org</uri>
        </room>
      </item>
    </publish>
  </pubsub>
</iq>
    ]]></example>
    <p>The chatting information is then delivered to all subscribers:</p>
    <example caption='Chatting Information is Delivered to All Subscribers'><![CDATA[
<message from='stpeter@jabber.org' to='maineboy@jabber.org'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='http://jabber.org/protocol/chatting'>
      <item id='1b395148292c0b0ab3a83bb2c22909bf83d2a80b'>
        <room xmlns='http://jabber.org/protocol/chatting'>
          <name>jdev</name>
          <uri>xmpp:jdev@conference.jabber.org</uri>
        </room>
      </item>
    </items>
  </event>
</message>
.
.
.
    ]]></example>
    <p>When the user exits the room, the user's client SHOULD send an empty &lt;room/&gt; element to the node with the same ItemID:</p>
    <example caption='User Publishes Exit Information'><![CDATA[
<iq type='set' from='stpeter@jabber.org/work' id='chatting2'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='http://jabber.org/protocol/chatting'>
      <item id='1b395148292c0b0ab3a83bb2c22909bf83d2a80b'>
        <room xmlns='http://jabber.org/protocol/chatting'/>
      </item>
    </publish>
  </pubsub>
</iq>
    ]]></example>
    <example caption='Empty Room Information is Delivered to All Subscribers'><![CDATA[
<message from='stpeter@jabber.org' to='maineboy@jabber.org'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='http://jabber.org/protocol/chatting'>
      <item id='1b395148292c0b0ab3a83bb2c22909bf83d2a80b'>
        <room xmlns='http://jabber.org/protocol/chatting'/>
      </item>
    </items>
  </event>
</message>
.
.
.
    ]]></example>
  </section2>
</section1>
<section1 topic='Security Considerations' anchor='security'>
  <p>The chat rooms that a user visits may be sensitive. A client must provide a way for a user to configure which rooms or types of rooms will not be published (e.g., via user preferences).</p>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>
  <p>This document requires no interaction with &IANA;.</p>
</section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <section2 topic='Protocol Namespaces' anchor='registrar-ns'>
    <p>The &REGISTRAR; shall include 'http://jabber.org/protocol/chatting' in its registry of protocol namespaces.</p>
  </section2>
</section1>
<section1 topic='XML Schema' anchor='schema'>
  <code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://jabber.org/protocol/chatting'
    xmlns='http://jabber.org/protocol/chatting'
    elementFormDefault='qualified'>

  <xs:element name='room'>
    <xs:complexType>
      <xs:sequence minOccurs='0'>
        <xs:element name='name' type='xs:string' minOccurs='0'/>
        <xs:element name='topic' type='xs:string' minOccurs='0'/>
        <xs:element name='uri' type='xs:anyURI'/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>
  ]]></code>
</section1>
</xep>