#include <privatexmlhandler.h>
Public Types | |
enum | PrivateXMLResult { PxmlStoreOk, PxmlStoreError, PxmlRequestError } |
Public Member Functions | |
virtual | ~PrivateXMLHandler () |
virtual void | handlePrivateXML (const std::string &tag, Tag *xml)=0 |
virtual void | handlePrivateXMLResult (const std::string &uid, PrivateXMLResult pxResult)=0 |
Derived classes can be registered as PrivateXMLHandlers with the PrivateXML object. Upon an incoming PrivateXML packet handlePrivateXML() will be called.
Definition at line 31 of file privatexmlhandler.h.
enum PrivateXMLResult |
Describes the possible results of a 'store' or 'request' operation.
PxmlStoreOk | Storing was successful. |
PxmlStoreError | An error occurred while storing data in Private XML. |
PxmlRequestError | An error occurred while requesting Private XML. |
Definition at line 37 of file privatexmlhandler.h.
virtual ~PrivateXMLHandler | ( | ) | [inline, virtual] |
Virtual Destructor.
Definition at line 47 of file privatexmlhandler.h.
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()
.
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 | pxResult | |||
) | [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()).
uid | The ID of the query. | |
pxResult | The result of the operation. |
Implemented in Annotations, BookmarkStorage, and RosterManager.