PrivateXMLHandler Class Reference

A virtual interface which can be reimplemented to store and receive private XML data. More...

#include <privatexmlhandler.h>

Inherited by Annotations [private], BookmarkStorage [private], and RosterManager [private].

Inheritance diagram for PrivateXMLHandler:

Inheritance graph
[legend]
List of all members.

Public Types

enum  PrivateXMLResult { PXML_STORE_OK, PXML_STORE_ERROR, PXML_REQUEST_ERROR }

Public Member Functions

virtual ~PrivateXMLHandler ()
virtual void handlePrivateXML (const std::string &tag, Tag *xml)=0
virtual void handlePrivateXMLResult (const std::string &uid, PrivateXMLResult result)=0

Detailed Description

A virtual interface which can be reimplemented to store and receive private XML data.

Derived classes can be registered as PrivateXMLHandlers with the PrivateXML object. Upon an incoming PrivateXML packet handlePrivateXML() will be called.

Author:
Jakob Schroeter <js@camaya.net>

Definition at line 31 of file privatexmlhandler.h.


Member Enumeration Documentation

enum PrivateXMLResult

Describes the possible results of a 'store' or 'request' operation.

Enumerator:
PXML_STORE_OK  Storing was successful.
PXML_STORE_ERROR  An error occurred while storing data in Private XML.
PXML_REQUEST_ERROR  An error occurred while requesting Private XML.

Definition at line 37 of file privatexmlhandler.h.


Constructor & Destructor Documentation

virtual ~PrivateXMLHandler (  )  [inline, virtual]

Virtual Destructor.

Definition at line 47 of file privatexmlhandler.h.


Member Function Documentation

virtual void handlePrivateXML ( const std::string &  tag,
Tag xml 
) [pure virtual]

Reimplement this function to receive the private XML that was requested earlier using PrivateXML::requestXML().

Parameters:
tag The tag of the storage packet.
xml The private xml, i.e. the first child of the <query> tag.

Implemented in Annotations, BookmarkStorage, and RosterManager.

virtual void handlePrivateXMLResult ( const std::string &  uid,
PrivateXMLResult  result 
) [pure virtual]

This function is called to notify about the result of a 'store' or 'request' operation (successful requests are announced by means of handlePrivateXML()).

Parameters:
uid The ID of the query.
result The result of the operation.
Since:
0.7

Implemented in Annotations, BookmarkStorage, and RosterManager.


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