XEP-0319: Last User Interaction in Presence

Abstract:This specification defines a way to communicate time of last user interaction with her system using XMPP presence notifications.
Author:Tobias Markmann
Copyright:© 1999 - 2015 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status:Draft
Type:Standards Track
Version:1.0
Last Updated:2015-04-02

NOTICE: The protocol defined herein is a Draft Standard of the XMPP Standards Foundation. Implementations are encouraged and the protocol is appropriate for deployment in production systems, but some changes to the protocol are possible before it becomes a Final Standard.


Table of Contents


1. Introduction
2. Use Cases
    2.1. Presence with Last Interaction
    2.2. Presence Indicating User Coming Back From Idle
3. XML Schema
4. Acknowledgements
5. Security Considerations
6. IANA Considerations
7. XMPP Registrar Considerations
    7.1. Protocol Namespace

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


1. Introduction

This protocol describes a way to communicate a user's last interaction time with other XMPP entities over <presence/> stanzas. For the purposes of this document, user interaction here refers to a human end user interacting with her device by means of a keyboard, mouse, touch screen, and so on. Based on this information XMPP clients can display the time a contact went idle or a duration for how long a contact has been idle, thereby allowing end users to estimate the expected responsiveness of their contacts.

This protocol uses absolute timestamps formatted according to XMPP Date and Time Profiles (XEP-0082) [1], indicated as value of the 'since' attribute in the <idle/> element.

Experience has shown a number of issues with Last Activity in Presence (XEP-0256) [2]:

Updating XEP-0256 directly would be problematic as it would break compatibility with existing implementations. Instead a new protocol is described for handling the idle time use case; the last online use case is handled by PubSub Since (XEP-0312) [4].

2. Use Cases

There are two main use cases for this extension, explained in more detail in the following sections.

2.1 Presence with Last Interaction

After a user has not interacted with her device for some amount of time the user wants to inform her contacts about this fact. The client sends a <presence/> stanza with time of last interaction.

Example 1. Time of Last User Interaction in Auto-Away

<presence from='juliet@capulet.com/balcony'>
  <show>away</show>
  <idle xmlns='urn:xmpp:idle:1' since='1969-07-21T02:56:15Z'/>
</presence>
    

The amount of time the user has to be idle before a client sends this enhanced presence is application-specific; it is suggested that a sensible default interval of 5 minutes be used.

2.2 Presence Indicating User Coming Back From Idle

When a user comes back and uses her device again the client informs user's contacts by sending a normal presence stanza like shown in the following example, omiting the <idle/> element.

Example 2. Presence Indicating Return to Device

<presence from='juliet@capulet.com/balcony' />
    

3. XML Schema

<?xml version="1.0" encoding="utf-8"?>

<xs:schema
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    elementFormDefault="qualified"
    targetNamespace="urn:xmpp:idle:1"
    xmlns="urn:xmpp:idle:1">

  <xs:annotation>
    <xs:documentation>
      The protocol documented by this schema is defined in
      XEP-0319: http://www.xmpp.org/extensions/xep-0319.html
    </xs:documentation>
  </xs:annotation>

  <xs:element name="idle">
    <xs:complexType>
      <xs:attribute name="since" use="required" type="xs:string"/>
    </xs:complexType>
  </xs:element>

</xs:schema>
      

4. Acknowledgements

Thanks to Florian Schmaus, Christian Schudt, and Lance Stout for their helpful comments.

5. Security Considerations

The security considerations of XEP-0082 apply to this protocol.

This specification introduces no new security or privacy concerns. While including a last user interaction notation in <presence/> updates can enable recipients to determine exactly when a user has stopped interacting with her XMPP client or even their system, this information is in essence already available if the user's client publishes timely presence updates.

6. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [5].

7. XMPP Registrar Considerations

7.1 Protocol Namespace

The XMPP Registrar [6] shall add 'urn:xmpp:idle:1' to its registry at http://xmpp.org/registrar/namespaces.html.


Appendices


Appendix A: Document Information

Series: XEP
Number: 0319
Publisher: XMPP Standards Foundation
Status: Draft
Type: Standards Track
Version: 1.0
Last Updated: 2015-04-02
Approving Body: XMPP Council
Dependencies: XMPP Core, XMPP IM, XEP-0082
Supersedes: XEP-0256
Superseded By: None
Short Name: idle
Source Control: HTML
This document in other formats: XML  PDF


Appendix B: Author Information

Tobias Markmann

Email: tmarkmann@googlemail.com
JabberID: tm@ayena.de


Appendix C: Legal Notices

Copyright

This XMPP Extension Protocol is copyright © 1999 - 2014 by the XMPP Standards Foundation (XSF).

Permissions

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.

Disclaimer of Warranty

## 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. ##

Limitation of Liability

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.

IPR Conformance

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 <http://xmpp.org/about-xmpp/xsf/xsf-ipr-policy/> or obtained by writing to XMPP Standards Foundation, 1899 Wynkoop Street, Suite 600, Denver, CO 80202 USA).

Appendix D: Relation to XMPP

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.


Appendix E: Discussion Venue

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>.


Appendix F: Requirements Conformance

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".


Appendix G: Notes

1. XEP-0082: XMPP Date and Time Profiles <http://xmpp.org/extensions/xep-0082.html>.

2. XEP-0256: Last Activity in Presence <http://xmpp.org/extensions/xep-0256.html>.

3. XEP-0203: Delayed Delivery <http://xmpp.org/extensions/xep-0203.html>.

4. XEP-0312: PubSub Since <http://xmpp.org/extensions/xep-0312.html>.

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/>.


Appendix H: Revision History

Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/

Version 1.0 (2015-04-02)

Per a vote of the XMPP Council, advanced specification from Experimental to Draft.

(XEP editor (mam))

Version 0.2 (2013-08-27)

Fix issues raised in XMPP Council meeting.

(tobias)

Version 0.1 (2013-03-04)

Initial published version approved by the XMPP Council.

(psa)

Version 0.0.1 (2013-02-17)

Initial version.

(tobias)

END