Package org.jivesoftware.smackx.xevent

Interface MessageEventRequestListener

All Known Implementing Classes:

DefaultMessageEventRequestListener

public interface MessageEventRequestListener

A listener that is fired anytime a message event request is received. 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 was delivered or when the receiver of the message is composing a reply.

Method Summary

Modifier and Type	Method	Description
void	composingNotificationRequested(Jid from, String packetID, MessageEventManager messageEventManager)	Called when a request that the receiver of the message is composing a reply notification is received.
void	deliveredNotificationRequested(Jid from, String packetID, MessageEventManager messageEventManager)	Called when a request for message delivered notification is received.
void	displayedNotificationRequested(Jid from, String packetID, MessageEventManager messageEventManager)	Called when a request for message displayed notification is received.
void	offlineNotificationRequested(Jid from, String packetID, MessageEventManager messageEventManager)	Called when a request that the receiver of the message is offline is received.

Method Detail

deliveredNotificationRequested

void deliveredNotificationRequested(Jid from,
                                    String packetID,
                                    MessageEventManager messageEventManager)
                             throws SmackException.NotConnectedException,
                                    InterruptedException

Called when a request for message delivered notification is received.

Parameters:

from - the user that sent the notification.

packetID - the id of the message that was sent.

messageEventManager - the messageEventManager that fired the listener.

Throws:

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

displayedNotificationRequested

void displayedNotificationRequested(Jid from,
                                    String packetID,
                                    MessageEventManager messageEventManager)

Called when a request for message displayed notification is received.

Parameters:

from - the user that sent the notification.

packetID - the id of the message that was sent.

messageEventManager - the messageEventManager that fired the listener.

composingNotificationRequested

void composingNotificationRequested(Jid from,
                                    String packetID,
                                    MessageEventManager messageEventManager)

Called when a request that the receiver of the message is composing a reply notification is received.

Parameters:

from - the user that sent the notification.

packetID - the id of the message that was sent.

messageEventManager - the messageEventManager that fired the listener.

offlineNotificationRequested

void offlineNotificationRequested(Jid from,
                                  String packetID,
                                  MessageEventManager messageEventManager)

Called when a request that the receiver of the message is offline is received.

Parameters:

from - the user that sent the notification.

packetID - the id of the message that was sent.

messageEventManager - the messageEventManager that fired the listener.