Publish-Subscribe (XEP-0060) [1] and Personal Eventing Protocol (XEP-0163) [2] 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.
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:
| Element | Description | Example | Datatype | Inclusion |
|---|---|---|---|---|
| name | The name of the chatroom | Jabber Development | xs:string | OPTIONAL |
| topic | The current topic of discussion in the room | BOSH meeting | xs:string | OPTIONAL |
| uri | A URI for the room (this SHOULD be an XMPP URI or IRI in accordance with RFC 5122 [3] but MAY use some other URI scheme, such as the irc: scheme) | xmpp:jdev@conference.jabber.org | xs:anyURI | REQUIRED |
NOTE: The datatypes specified above are defined in XML Schema Part 2 [4].
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.
<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:
<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:
<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>
<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>
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).
This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [5].
This specification defines the following XML namespace:
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 <https://xmpp.org/registrar/namespaces.html>, as described in Section 4 of XMPP Registrar Function (XEP-0053) [7].
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>
This document in other formats: XML PDF
This XMPP Extension Protocol is copyright © 1999 – 2020 by the XMPP Standards Foundation (XSF).
Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.
## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##
In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.
This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).
The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.
The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.
The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.
Discussion on other xmpp.org discussion lists might also be appropriate; see <http://xmpp.org/about/discuss.shtml> for a complete list.
Errata can be sent to <editor@xmpp.org>.
The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".
1. XEP-0060: Publish-Subscribe <https://xmpp.org/extensions/xep-0060.html>.
2. XEP-0163: Personal Eventing Protocol <https://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/xmlschema11-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 <https://xmpp.org/registrar/>.
7. XEP-0053: XMPP Registrar Function <https://xmpp.org/extensions/xep-0053.html>.
Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/
Modified namespace in accordance with protocol versioning policies.
Updated in accordance with XEP-0163.
Initial version.
First draft.
END