FlexibleOfflineHandler Class Reference

Implementation of this virtual interface allows for retrieval of offline messages following JEP-0030. More...

#include <flexoffhandler.h>

List of all members.

Public Types

enum  FlexibleOfflineResult {
  FOMR_REMOVE_SUCCESS, FOMR_REQUEST_SUCCESS, FOMR_FORBIDDEN, FOMR_ITEM_NOT_FOUND,
  FOMR_UNKNOWN_ERROR
}

Public Member Functions

virtual ~FlexibleOfflineHandler ()
virtual void handleFlexibleOfflineSupport (bool support)=0
virtual void handleFlexibleOfflineMsgNum (int num)=0
virtual void handleFlexibleOfflineMessageHeaders (StringMap &headers)=0
virtual void handleFlexibleOfflineResult (FlexibleOfflineResult result)=0


Detailed Description

Implementation of this virtual interface allows for retrieval of offline messages following JEP-0030.

Author:
Jakob Schroeter <js@camaya.net>
Since:
0.7

Definition at line 27 of file flexoffhandler.h.


Member Enumeration Documentation

enum FlexibleOfflineResult

Describes the possible results of a message retrieval or deletion request.

Enumerator:
FOMR_REMOVE_SUCCESS  Message(s) were removed successfully.
FOMR_REQUEST_SUCCESS  Message(s) were fetched successfully.
FOMR_FORBIDDEN  The requester is a JID other than an authorized resource of the user. Something wnet serieously wrong
FOMR_ITEM_NOT_FOUND  The requested node (message ID) does not exist.
FOMR_UNKNOWN_ERROR  An error occurred which is not specified in JEP-0013.

Definition at line 33 of file flexoffhandler.h.


Constructor & Destructor Documentation

virtual ~FlexibleOfflineHandler (  )  [inline, virtual]

Virtual Destructor.

Definition at line 46 of file flexoffhandler.h.


Member Function Documentation

virtual void handleFlexibleOfflineSupport ( bool  support  )  [pure virtual]

This function is called to indicate whether the server supports JEP-0013 or not. Call FlexibleOffline::checkSupport() to trigger the check.

Parameters:
support Whether the server support JEP-0013 or not.

Referenced by FlexibleOffline::handleDiscoInfoResult().

virtual void handleFlexibleOfflineMsgNum ( int  num  )  [pure virtual]

This function is called to announce the number of available offline messages. Call FlexibleOffline::getMsgCount() to trigger the check.

Parameters:
num The number of stored offline messages.

Referenced by FlexibleOffline::handleDiscoInfoResult().

virtual void handleFlexibleOfflineMessageHeaders ( StringMap headers  )  [pure virtual]

This function is called when the offline message headers arrive. Call FlexibleOffline::fetchHeaders() to trigger the check.

Parameters:
headers A map of ID/sender pairs describing the offline messages.

Referenced by FlexibleOffline::handleDiscoItemsResult().

virtual void handleFlexibleOfflineResult ( FlexibleOfflineResult  result  )  [pure virtual]

This function is called to indicate the result of a fetch or delete instruction.

Parameters:
result The result of the operation.

Referenced by FlexibleOffline::handleIqID().


The documentation for this class was generated from the following file:
Generated on Tue May 1 14:20:23 2007 for gloox by  doxygen 1.5.1