<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep xmlns="">
<header>
  <title>Generic Alerts</title>
  <abstract>A protocol for generic alerts (similar to .NET Alerts service).</abstract>
  
<legal>
<copyright>This XMPP Extension Protocol is copyright © 1999 – 2024 by the <link url="https://xmpp.org/">XMPP Standards Foundation</link> (XSF).</copyright>
<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.</permissions>
<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. ##</warranty>
<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.</liability>
<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 &lt;<link url="https://xmpp.org/about/xsf/ipr-policy">https://xmpp.org/about/xsf/ipr-policy</link>&gt; or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).</conformance>
</legal>
  <number>0089</number>
  <status>Deferred</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <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" anchor="registrar">
  <p>The <span class="ref"><link url="https://xmpp.org/registrar/">XMPP Registrar</link></span> <note>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 &lt;<link url="https://xmpp.org/registrar/">https://xmpp.org/registrar/</link>&gt;.</note> will need to register the new namespace of "http://jabber.org/protocol/alert".</p>
</section1>
</xep>
