One document matched: draft-garcia-simple-poke-00.txt
SIMPLE G. Garcia
Internet-Draft J. Martin
Intended status: Standards Track Telefonica I+D
Expires: December 18, 2008 June 16, 2008
Attention Request (POKE) for Instant Messaging
draft-garcia-simple-poke-00
Status of this Memo
By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware
have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet-
Drafts.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html.
This Internet-Draft will expire on December 18, 2008.
Abstract
This document specifies a message content type and XML format to
request attention from a targeted user. This feature is usually
known as poke, nudge or buzz in existing messaging platforms. Its
primary use is as an additional instant messaging capability that can
be sent in the middle of a instant messaging session or in a
standalone message at any time. This message also allows the sender
to indicate the preferred realization of the attention request:
vibrator, light, tone, media or text.
Garcia & Martin Expires December 18, 2008 [Page 1]
Internet-Draft POKE June 2008
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3
2. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Message Content . . . . . . . . . . . . . . . . . . . . . . . 4
4. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
5. XML Document Format . . . . . . . . . . . . . . . . . . . . . 5
6. Security Considerations . . . . . . . . . . . . . . . . . . . 8
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
7.1. Content-Type Registration for 'application/im-poke+xml' . 9
7.2. URN Sub-Namespace Registration for
'urn:ietf:params:xml:ns:im-poke' . . . . . . . . . . . . . 10
7.3. Schema registration . . . . . . . . . . . . . . . . . . . 10
8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 10
9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 11
9.1. Normative References . . . . . . . . . . . . . . . . . . . 11
9.2. Informative References . . . . . . . . . . . . . . . . . . 11
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 11
Intellectual Property and Copyright Statements . . . . . . . . . . 12
Garcia & Martin Expires December 18, 2008 [Page 2]
Internet-Draft POKE June 2008
1. Introduction
Some existing messaging platforms include the capability to send a
message to a user requesting his attention (e.g. XMPP [XEP-0224]).
This feature is usually known as poke, nudge or buzz, and in desktop
applications the notification is usually implemented using a
combination of sound and the vibration of chat windows.
This document describes the XML message format and procedures to send
this attention request.
1.1. Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
2. Overview
The poke message can be used inside an instant messaging session (for
example a MSRP session) or as a standalone message (for example in a
SIP MESSAGE). In session mode, the poke message is sent as part of
the messaging stream and its usage is negotiated just like any other
media type in that stream, with details depending on the session mode
protocol.
In the poke message the sender can include the preference for the
realization of the attention request in the receiving side: vibrator,
light, tone, media or text. This is just an indication and the final
decission of the realization is in the receiver depending on the
terminal capabilities and the user configuration.
A poke message can include more than one realization to define
complex patterns (e.g. light + vibrator). The receiver SHOULD start
all the realizations (from the beginning and following the order in
the XML document) in parallel until it finds one marked as
"waitForPrevious". When that mark is found the receiver SHOULD wait
until the end of all the previous realization before starting this
realization and next ones. There is also a special realization
called silence that can be used to specify a pause in the sequence
and create more complex patterns.
The vibrator realization could be implemented using a mechanical
vibration or software vibration of the user interface. The
parameters of this realization are the duration, frequency and
intensity
Garcia & Martin Expires December 18, 2008 [Page 3]
Internet-Draft POKE June 2008
The light realization could be implemented changing the bright of the
main display of the device or switching on additional lights in the
device. The parameters of this realization are the duration,
lightSource, color and intensity
The media indication could be implemented playing the media file
referenced in the uri parameter, which depending on the content type
could be an image, sound or video.
The tone realization could be implemented generating and playing the
tone specified using the parameters duration, frequency and
intensity.
The text realization could be implemented showing the text to the
user. The parameters of this realization are the duration and text.
The silence realization includes only the duration parameter.
If the receiver of the poke message do not support a realization
(e.g. light) it SHOULD use a default indication (e.g. vibration). If
the receiver do not support a parameter of the realization (e.g.
ligthSource=cameraFlash) it SHOULD use a default value for that
parameter.
3. Message Content
We briefly describe the message content to summarize the discussion
above. This description is non-normative. The schema (Section 5)
should be consulted for the normative message format.
The root of the message is the poke element. This root element
contains a sequence of elements describing the pokes realizations
(vibrator, light, tone, media, text and silence) and their associated
parameters. Each realization element has a "waitForPrevious"
attribute.
The duration attribute is indicated in milliseconds, the frequency is
specified in herzs, and the intensity is defined in a 0 to 100 range.
In the light element, lightSource specifies the preferred light,
flashing allows to request light flickering, and color specifies the
preferred color as RGB value in hexadecimal notation ('#' immediately
followed by six hexadecimal characters encoding the RGB components as
#rrggbb).
Garcia & Martin Expires December 18, 2008 [Page 4]
Internet-Draft POKE June 2008
4. Examples
This is the simplest possible poke:
<?xml version="1.0" encoding="UTF-8"?>
<poke xmlns="urn:ietf:params:xml:ns:im-poke"/>
A poke requesting to show a text after executing a sequence of lights
and tones in parallel:
<?xml version="1.0" encoding="UTF-8"?>
<poke xmlns="urn:ietf:params:xml:ns:im-poke">
<light duration="500" flashing="true"/>
<tone duration="500" frequency="660"/>
<light duration="500" flashing="true" waitForPrevious="true"/>
<tone duration="500" frequency="660"/>
<light duration="500" flashing="true" waitForPrevious="true"/>
<tone duration="500" frequency="660"/>
<text duration="2000" waitForPrevious="true">
Joe is poking you!
</text>
</poke>
A poke requesting to execute a sequence of vibrations:
<?xml version="1.0" encoding="UTF-8"?>
<poke xmlns="urn:ietf:params:xml:ns:im-poke">
<vibration duration="500" frequency="30"/>
<silence duration="250"/>
<vibration duration="500" frequency="30" waitForPrevious="true"/>
</poke>
5. XML Document Format
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="urn:ietf:params:xml:ns:im-poke"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xs:element name="poke">
<xs:complexType>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="vibration">
<xs:complexType>
<xs:attribute name="waitForPrevious" type="xs:boolean"
use="optional" default="false"/>
<xs:attribute name="duration" use="optional">
Garcia & Martin Expires December 18, 2008 [Page 5]
Internet-Draft POKE June 2008
<xs:simpleType>
<xs:restriction base="xs:long">
<xs:minInclusive value="0"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="frequency" use="optional">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="intensity" use="optional">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="100"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="light">
<xs:complexType>
<xs:attribute name="waitForPrevious" type="xs:boolean"
use="optional" default="false"/>
<xs:attribute name="duration" use="optional">
<xs:simpleType>
<xs:restriction base="xs:long">
<xs:minInclusive value="0"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="intensity" use="optional">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="100"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="color" type="xs:string" use="optional"/>
<xs:attribute name="lightSource" use="optional">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="default"/>
<xs:enumeration value="primaryDisplay"/>
Garcia & Martin Expires December 18, 2008 [Page 6]
Internet-Draft POKE June 2008
<xs:enumeration value="secondaryDisplay"/>
<xs:enumeration value="cameraFlash"/>
<xs:enumeration value="keypad"/>
<xs:enumeration value="otherById"/>
<xs:enumeration value=""/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="lightSourceId" type="xs:string"
use="optional"/>
<xs:attribute name="flashing" type="xs:boolean"
use="optional"/>
</xs:complexType>
</xs:element>
<xs:element name="media">
<xs:complexType>
<xs:all>
<xs:element name="uri">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:anyURI">
<xs:attribute name="contentType" type="xs:string"
use="optional"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:all>
<xs:attribute name="waitForPrevious" type="xs:boolean"
use="optional" default="false"/>
</xs:complexType>
</xs:element>
<xs:element name="tone">
<xs:complexType>
<xs:attribute name="waitForPrevious" type="xs:boolean"
use="optional" default="false"/>
<xs:attribute name="duration" use="optional">
<xs:simpleType>
<xs:restriction base="xs:long">
<xs:minInclusive value="0"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="frequency" use="optional">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
</xs:restriction>
Garcia & Martin Expires December 18, 2008 [Page 7]
Internet-Draft POKE June 2008
</xs:simpleType>
</xs:attribute>
<xs:attribute name="intensity" use="optional">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="100"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="text">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="waitForPrevious" type="xs:boolean"
use="optional" default="false"/>
<xs:attribute name="duration" use="optional">
<xs:simpleType>
<xs:restriction base="xs:long">
<xs:minInclusive value="0"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="silence">
<xs:complexType>
<xs:attribute name="duration" type="xs:long"
use="required"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
6. Security Considerations
The poke message is a specialized type of instant messaging, all the
security considerations for the instant messages also applies to
pokes memssages.
Duration of pokes and pokes rate MUST be controlled and limited in
Garcia & Martin Expires December 18, 2008 [Page 8]
Internet-Draft POKE June 2008
the receiving side to minify the effect of malicious nodes sending
pokes too long or too often (the limit is an implementor decission).
Poke messages of media type include a url to the media content that
can pose a security risk. It is RECOMMENDED to access the
information in the uri element only if it can verify the authenticity
of the element that originated the message and trust that element, to
avoid accessing dangerous or inapropiate contents.
7. IANA Considerations
7.1. Content-Type Registration for 'application/im-poke+xml'
To: ietf-types@iana.org
Subject: Registration of MIME media type application/
im-poke+xml
MIME media type name: application
MIME subtype name: im-poke+xml
Required parameters: (none)
Optional parameters: charset; Indicates the character encoding of
enclosed XML. Default is UTF-8.
Encoding considerations: Uses XML, which can employ 8-bit characters,
depending on the character encoding used. See [RFC3023],
section 3.2.
Security considerations: This content type is designed to carry
information about current user activity, which may be considered
private information. Appropriate precautions should be adopted to
limit disclosure of this information.
Interoperability considerations: This content type provides a common
format for sending attention requests.
Published specification: RFC XXXX
Applications which use this media type: Instant messaging systems.
Additional information: none
Person & email address to contact for further information: Gustavo
Garcia, ggb@tid.es
Intended usage: LIMITED USE
Author/Change controller: This specification is a work item of the
IETF SIMPLE working group, with the mailing list address
simple@ietf.org.
Other information: This media type is a specialization of
application/xml [RFC3023], and many of the considerations
described there also apply to application/im-poke+xml.
Garcia & Martin Expires December 18, 2008 [Page 9]
Internet-Draft POKE June 2008
7.2. URN Sub-Namespace Registration for
'urn:ietf:params:xml:ns:im-poke'
URI: urn:ietf:params:xml:ns:im-poke
Description: This is the XML namespace for XML elements defined by
[RFC XXXX] to describe attention request by an instant messaging
client using the application/im-poke+xml content type.
Registrant Contact: IETF, SIMPLE working group, simple@ietf.org,
Gustavo Garcia, ggb@tid.es
XML:
BEGIN
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN"
"http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type"
content="text/html;charset=iso-8859-1"/>
<title>Attention Request (POKE) for Instant Messaging</title>
</head>
<body>
<h1>Namespace for SIMPLE poke extension</h1>
<h2>urn:ietf:params:xml:ns:im-poke</h2>
<p>See <a href="[URL of published RFC]">[RFCXXXX]</a>.</p>
</body>
</html>
END
7.3. Schema registration
This section registers a new XML schema per the procedures in
[RFC3688].
URI: urn:ietf:params:xml:schema:im-poke
Registrant Contact: IETF, SIMPLE working group, (simple@ietf.org),
Gustavo Garcia (ggb@tid.es).
The XML for this schema can be found as the sole content of
Section 5.
8. Acknowledgements
We would like to acknowledge the valuable ideas and support given by
Guido Garcia and the useful comments received from Jose Luis Urien.
Garcia & Martin Expires December 18, 2008 [Page 10]
Internet-Draft POKE June 2008
9. References
9.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media
Types", RFC 3023, January 2001.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
January 2004.
9.2. Informative References
[XEP-0224]
Monitzer, A., "XEP-0224: Attention", august 2008.
Authors' Addresses
Gustavo Garcia
Telefonica I+D
Emilio Vargas
Madrid, Madrid
Spain
Phone: +34 913129826
Email: ggb@tid.es
Jose-Luis Martin
Telefonica I+D
Parque Tecnologico de Boecillo
Boecillo, Valladolid
Spain
Phone: +34 983367902
Email: jlmp@tid.es
Garcia & Martin Expires December 18, 2008 [Page 11]
Internet-Draft POKE June 2008
Full Copyright Statement
Copyright (C) The IETF Trust (2008).
This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors
retain all their rights.
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property
The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information
on the procedures with respect to rights in RFC documents can be
found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at
ietf-ipr@ietf.org.
Garcia & Martin Expires December 18, 2008 [Page 12]
| PAFTECH AB 2003-2026 | 2026-04-23 22:47:26 |