mirror of
https://github.com/moparisthebest/xeps
synced 2024-11-23 01:32:22 -05:00
83 lines
3.0 KiB
XML
83 lines
3.0 KiB
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>Generic Alerts</title>
|
|
<abstract>A protocol for generic alerts (similar to .NET Alerts service).</abstract>
|
|
&LEGALNOTICE;
|
|
<number>0089</number>
|
|
<status>Deferred</status>
|
|
<type>Standards Track</type>
|
|
<sig>Standards</sig>
|
|
<dependencies/>
|
|
<supersedes/>
|
|
<supersededby/>
|
|
<shortname>Not yet assigned</shortname>
|
|
<!-- firstname, surname, email, and jid are all MANDATORY per XEP-0001 -->
|
|
<!-- include one author section for each co-author -->
|
|
<author>
|
|
<firstname>Richard</firstname>
|
|
<surname>Dobson</surname>
|
|
<email>richard@dobson-i.net</email>
|
|
<jid>richard@dobson-i.net</jid>
|
|
</author>
|
|
<revision>
|
|
<version>0.2</version>
|
|
<date>2003-05-16</date>
|
|
<initials>red</initials>
|
|
<remark>Changed element from x to alert.</remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.1</version>
|
|
<date>2003-05-12</date>
|
|
<initials>red</initials>
|
|
<remark>Initial version.</remark>
|
|
</revision>
|
|
</header>
|
|
<section1 topic='Introduction'>
|
|
<p>Generic Alerts is a way to extend headlines to allow functionality similar to .NET Alerts.</p>
|
|
</section1>
|
|
<section1 topic='Requirements'>
|
|
<p>The motivations for this document are:</p>
|
|
<ul>
|
|
<li>To allow services to send alerts to users, e.g. like an auction notifying you when you are outbid or that you have won</li>
|
|
</ul>
|
|
</section1>
|
|
<section1 topic='Use Cases'>
|
|
<section2 topic='Generic Alert message'>
|
|
<p>Generic Alerts extend headline messages to specify such things as a logo (32x32 png) and url to goto when the alert is clicked:</p>
|
|
<example caption='Generic alert message'><![CDATA[
|
|
<message to='user@domain.com' from='domain.com' type='headline' id='alert1'>
|
|
<subject>Auction Alert</subject>
|
|
<body>You have been outbid!</body>
|
|
<alert xmlns='http://jabber.org/protocol/alert'>
|
|
<logo>http://www.auction.com/alert.png</logo>
|
|
<url>http://www.auction.com/item?1292192</url>
|
|
</alert>
|
|
</message>]]></example>
|
|
</section2>
|
|
</section1>
|
|
<section1 topic='Implementation Notes'>
|
|
<p>The following guidelines may assist client developers.</p>
|
|
<ul>
|
|
<li>The existance of an alert element of the namespace 'http://jabber.org/protocol/alert' means this is an alert and not a normal headline.</li>
|
|
<li>Alerts should be displayed differently, possibly in toast popups.</li>
|
|
<li>The logo is an optional graphic to display representing the service being alerted on, e.g. ebay logo.</li>
|
|
<li>When clicked on the users web browser will be opened to the specified url.</li>
|
|
</ul>
|
|
</section1>
|
|
<section1 topic='Security Considerations'>
|
|
<p>None.</p>
|
|
</section1>
|
|
<section1 topic='IANA Considerations'>
|
|
<p>No IANA interaction required.</p>
|
|
</section1>
|
|
<section1 topic='XMPP Registrar Considerations'>
|
|
<p>The ®ISTRAR; will need to register the new namespace of "http://jabber.org/protocol/alert".</p>
|
|
</section1>
|
|
</xep>
|