Annotations Class Reference

This is an implementation of JEP-0145 (Annotations). More...

#include <annotations.h>

Inherits PrivateXML, and PrivateXMLHandler.

Inheritance diagram for Annotations:

Inheritance graph
[legend]
Collaboration diagram for Annotations:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Annotations (ClientBase *parent)
virtual ~Annotations ()
void storeAnnotations (const AnnotationsHandler::AnnotationsList &aList)
void requestAnnotations ()
void registerAnnotationsHandler (AnnotationsHandler *ah)
void removeAnnotationsHandler ()
virtual void handlePrivateXML (const std::string &tag, Tag *xml)
virtual void handlePrivateXMLResult (const std::string, PrivateXMLResult)

Detailed Description

This is an implementation of JEP-0145 (Annotations).

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

Definition at line 38 of file annotations.h.


Constructor & Destructor Documentation

Annotations ClientBase parent  ) 
 

Constructs a new Annotations object.

Parameters:
parent The ClientBase to use for communication.

Definition at line 22 of file annotations.cpp.

~Annotations  )  [virtual]
 

Virtual destructor.

Definition at line 28 of file annotations.cpp.


Member Function Documentation

void handlePrivateXML const std::string &  tag,
Tag xml
[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.

Implements PrivateXMLHandler.

Definition at line 58 of file annotations.cpp.

References Tag::children().

void registerAnnotationsHandler AnnotationsHandler ah  ) 
 

Use this function to register a AnnotationsHandler.

Parameters:
ah The AnnotationsHandler which shall receive retrieved notes.

Definition at line 88 of file annotations.cpp.

void removeAnnotationsHandler  ) 
 

Use this function to un-register the AnnotationsHandler.

Definition at line 93 of file annotations.cpp.

void requestAnnotations  ) 
 

Use this function to initiate retrieval of annotations. Use registerAnnotationsHandler() to register an object which will receive the lists of notes.

Definition at line 53 of file annotations.cpp.

References PrivateXML::requestXML().

void storeAnnotations const AnnotationsHandler::AnnotationsList aList  ) 
 

Use this function to store notes (annotations to contacts in a roster) on the server. Make sure you store the whole set of annotations, not a 'delta'.

Parameters:
aList A list of notes to store.

Definition at line 32 of file annotations.cpp.

References Tag::addAttrib(), and Tag::addChild().


The documentation for this class was generated from the following files:
Generated on Mon Jan 16 16:19:55 2006 for gloox by  doxygen 1.4.6