XEP-0194: User Chatting

1. Introduction
2. Protocol
    2.1. Container Element and Child Elements
    2.2. Transport Mechanism
3. Security Considerations
4. IANA Considerations
5. XMPP Registrar Considerations
    5.1. Protocol Namespaces
    5.2. Namespace Versioning
6. XML Schema

Appendices
    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History

2.1 Container Element and Child Elements

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 <room/> element that is qualified by the 'urn:xmpp:chatting:0' namespace (see Namespace Versioning regarding the possibility of incrementing the version number). The chatting information itself is provided as the XML character data of the following children of the <room/> element:

NOTE: The datatypes specified above are defined in XML Schema Part 2 [4].

2.2 Transport Mechanism

When a user joins a room, its client MAY publish that fact to a PEP node whose NodeID is "urn:xmpp:chatting:0" (see Namespace Versioning regarding the possibility of incrementing the version number) or to a generic pubsub node. 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.

Example 1. User Publishes Chatting Information

<iq type='set' from='stpeter@jabber.org/work' id='chatting1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='urn:xmpp:chatting:0'>
      <item id='1b395148292c0b0ab3a83bb2c22909bf83d2a80b'>
        <room xmlns='urn:xmpp:chatting:0'>
          <name>Jabber Development</name>
          <uri>xmpp:jdev@conference.jabber.org</uri>
        </room>
      </item>
    </publish>
  </pubsub>
</iq>
    

The chatting information is then delivered to all subscribers:

Example 2. Chatting Information is Delivered to All Subscribers

<message from='stpeter@jabber.org' to='maineboy@jabber.org'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:chatting:0'>
      <item id='1b395148292c0b0ab3a83bb2c22909bf83d2a80b'>
        <room xmlns='urn:xmpp:chatting:0'>
          <name>Jabber Development</name>
          <uri>xmpp:jdev@conference.jabber.org</uri>
        </room>
      </item>
    </items>
  </event>
</message>
    

When the user exits the room, the user's client SHOULD send an empty <room/> element with the same ItemID:

Example 3. User Publishes Exit Information

<iq type='set' from='stpeter@jabber.org/work' id='chatting2'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='urn:xmpp:chatting:0'>
      <item id='1b395148292c0b0ab3a83bb2c22909bf83d2a80b'>
        <room xmlns='urn:xmpp:chatting:0'/>
      </item>
    </publish>
  </pubsub>
</iq>
    

Example 4. Exit Information is Delivered to All Subscribers

<message from='stpeter@jabber.org' to='maineboy@jabber.org'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:chatting:0'>
      <item id='1b395148292c0b0ab3a83bb2c22909bf83d2a80b'>
        <room xmlns='urn:xmpp:chatting:0'/>
      </item>
    </items>
  </event>
</message>
    

5.1 Protocol Namespaces

This specification defines the following XML namespace:

• urn:xmpp:chatting:0

Upon advancement of this specification from a status of Experimental to a status of Draft, the XMPP Registrar [6] shall add the foregoing namespace to the registry located at <http://xmpp.org/registrar/namespaces.html>, as described in Section 4 of XMPP Registrar Function [7].

5.2 Namespace Versioning

If the protocol defined in this specification undergoes a revision that is not fully backwards-compatible with an older version, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of XEP-0053.

<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='urn:xmpp:chatting:0'
    xmlns='urn:xmpp:chatting:0'
    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>
  

Peter Saint-Andre

Email: stpeter@jabber.org
JabberID: stpeter@jabber.org
URI: https://stpeter.im/

Copyright

Permissions

Disclaimer of Warranty

Limitation of Liability

IPR Conformance

1. XEP-0060: Publish-Subscribe <http://xmpp.org/extensions/xep-0060.html>.

2. XEP-0163: Personal Eventing Protocol <http://xmpp.org/extensions/xep-0163.html>.

3. RFC 5122: Internationalized Resource Identifiers (IRIs) and Uniform Resource Identifiers (URIs) for the Extensible Messaging and Presence Protocol (XMPP) <http://tools.ietf.org/html/rfc5122>.

4. XML Schema Part 2: Datatypes <http://www.w3.org/TR/xmlschema-2/>.

5. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

6. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <http://xmpp.org/registrar/>.

7. XEP-0053: XMPP Registrar Function <http://xmpp.org/extensions/xep-0053.html>.

Version 0.3 (2008-09-25)

Version 0.2 (2007-10-03)

Version 0.1 (2006-08-30)

Version 0.0.1 (2006-08-28)