From e516bf87309350e51888477659bfa261f0609a7a Mon Sep 17 00:00:00 2001 From: Gaston Dombiak Date: Mon, 18 Aug 2003 20:18:19 +0000 Subject: [PATCH] comments modified to display fine in javadoc git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@2034 b35dd754-fafc-0310-a699-88a17e54d16e --- .../smackx/MessageEventRequestListener.java | 12 +++-- .../smackx/packet/MessageEvent.java | 52 +++++++++++-------- 2 files changed, 36 insertions(+), 28 deletions(-) diff --git a/source/org/jivesoftware/smackx/MessageEventRequestListener.java b/source/org/jivesoftware/smackx/MessageEventRequestListener.java index b1dc1dc40..e9a7d5e8e 100644 --- a/source/org/jivesoftware/smackx/MessageEventRequestListener.java +++ b/source/org/jivesoftware/smackx/MessageEventRequestListener.java @@ -58,11 +58,13 @@ package org.jivesoftware.smackx; * Message event requests are received when the received message includes an extension * like this: * - * - * - * - * - * + * 
+ * <x xmlns='jabber:x:event'>
+ *  <offline/>
+ *  <delivered/>
+ *  <composing/>
+ * </x>
+ *
* * In this example you can see that the sender of the message requests to be notified * when the user couldn't receive the message because he/she is offline, the message diff --git a/source/org/jivesoftware/smackx/packet/MessageEvent.java b/source/org/jivesoftware/smackx/packet/MessageEvent.java index 1709908d7..430c91365 100644 --- a/source/org/jivesoftware/smackx/packet/MessageEvent.java +++ b/source/org/jivesoftware/smackx/packet/MessageEvent.java @@ -58,30 +58,32 @@ import org.jivesoftware.smack.packet.PacketExtension; /** * Represents message events relating to the delivery, display, composition and cancellation of - * messages. + * messages.

* * There are four message events currently defined in this namespace: - * 1.Offline + *

    + *
  1. Offline
    * Indicates that the message has been stored offline by the intended recipient's server. This * event is triggered only if the intended recipient's server supports offline storage, has that - * support enabled, and the recipient is offline when the server receives the message for delivery. + * support enabled, and the recipient is offline when the server receives the message for delivery.
    2. * - * 2.Delivered + *
  2. Delivered
    * Indicates that the message has been delivered to the recipient. This signifies that the message * has reached the recipient's XMPP client, but does not necessarily mean that the message has - * been displayed. This event is to be raised by the XMPP client. + * been displayed. This event is to be raised by the XMPP client.
    3. * - * 3.Displayed + *
  3. Displayed
    * Once the message has been received by the recipient's XMPP client, it may be displayed to the * user. This event indicates that the message has been displayed, and is to be raised by the * XMPP client. Even if a message is displayed multiple times, this event should be raised only - * once. + * once.
    4. * - * 4.Composing + *
  4. Composing
    * In threaded chat conversations, this indicates that the recipient is composing a reply to a * message. The event is to be raised by the recipient's XMPP client. A XMPP client is allowed * to raise this event multiple times in response to the same request, providing the original - * event is cancelled first. + * event is cancelled first.
    5. + *
* * @author Gaston Dombiak */ @@ -305,27 +307,31 @@ public class MessageEvent implements PacketExtension { * Returns the XML representation of a Message Event according the specification. * * Usually the XML representation will be inside of a Message XML representation like - * in the following examples: + * in the following examples:

* * Request to be notified when displayed: - * + * <message * to='romeo@montague.net/orchard' * from='juliet@capulet.com/balcony' - * id='message22'> - * - * - * - * + * id='message22'> + * <x xmlns='jabber:x:event'> + * <displayed/> + * </x> + * </message> + * * * Notification of displayed: - * + * <message * from='romeo@montague.net/orchard' - * to='juliet@capulet.com/balcony'> - * - * - * message22 - * - * + * to='juliet@capulet.com/balcony'> + * <x xmlns='jabber:x:event'> + * <displayed/> + * <id>message22</id> + * </x> + * </message> + * * */ public String toXML() {