gloox  1.0.20
Public Member Functions | List of all members
Annotations Class Reference

#include <annotations.h>

Inheritance diagram for Annotations:
Inheritance graph

Public Member Functions

 Annotations (ClientBase *parent)
virtual ~Annotations ()
void storeAnnotations (const AnnotationsList &aList)
void requestAnnotations ()
void registerAnnotationsHandler (AnnotationsHandler *ah)
void removeAnnotationsHandler ()
virtual void handlePrivateXML (const Tag *xml)
virtual void handlePrivateXMLResult (const std::string &uid, PrivateXMLResult pxResult)
- Public Member Functions inherited from PrivateXML
 PrivateXML (ClientBase *parent)
virtual ~PrivateXML ()
std::string requestXML (const std::string &tag, const std::string &xmlns, PrivateXMLHandler *pxh)
std::string storeXML (const Tag *tag, PrivateXMLHandler *pxh)
virtual bool handleIq (const IQ &iq)
virtual void handleIqID (const IQ &iq, int context)
- Public Member Functions inherited from IqHandler
virtual ~IqHandler ()
- Public Member Functions inherited from PrivateXMLHandler
virtual ~PrivateXMLHandler ()

Additional Inherited Members

- Public Types inherited from PrivateXMLHandler
enum  PrivateXMLResult { PxmlStoreOk, PxmlStoreError, PxmlRequestError }

Detailed Description

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

You can use this class to store arbitrary notes about a roster item on the server (and to retrieve them later on). To retrieve all stored annotations for the current user's roster you have to create a class which inherits from AnnotationsHandler. This handler receives retrieved notes.

class MyClass : public AnnotationsHandler
// ...
void myFuncRetrieve();
void myFuncStore();
void handleAnnotations( const AnnotationsList &aList );
Annotations* m_notes;
void MyClass::myFuncRetrieve()
m_notes = new Annotations( m_client );
void MyClass::handleAnnotations( const AnnotationsList &aList )
m_list = aList;

To store an additional note you have to fetch the currently stored notes first, add your new note to the list of notes, and transfer them all together back to the server. This protocol does not support storage of 'deltas', that is, when saving notes all previously saved notes are overwritten.

void MyClass::myFuncStore()
annotationsListItem item;
item.jid = "";
item.cdate = "2006-02-04T15:23:21Z";
item.note = "some guy at";
m_list.push_back( item );
item.jid = "";
item.cdate = "2006-01-24T15:23:21Z";
item.mdate = "2006-02-04T05:11:46Z";
item.note = "some other guy";
m_list.push_back( item );
m_notes->storeAnnotations( m_list );
Jakob Schröter

Definition at line 94 of file annotations.h.

Constructor & Destructor Documentation

◆ Annotations()

Annotations ( ClientBase parent)

Constructs a new Annotations object.

parentThe ClientBase to use for communication.

Definition at line 22 of file annotations.cpp.

◆ ~Annotations()

~Annotations ( )

Virtual destructor.

Definition at line 28 of file annotations.cpp.

Member Function Documentation

◆ handlePrivateXML()

void handlePrivateXML ( const Tag xml)

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

xmlThe private xml, i.e. the first child of the <query> tag. May be 0. You should not delete the object.

Implements PrivateXMLHandler.

Definition at line 53 of file annotations.cpp.

◆ handlePrivateXMLResult()

void handlePrivateXMLResult ( const std::string &  uid,
PrivateXMLResult  pxResult 

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

uidThe ID of the query.
pxResultThe result of the operation.

Implements PrivateXMLHandler.

Definition at line 86 of file annotations.cpp.

◆ registerAnnotationsHandler()

void registerAnnotationsHandler ( AnnotationsHandler ah)

Use this function to register a AnnotationsHandler.

ahThe AnnotationsHandler which shall receive retrieved notes.

Definition at line 125 of file annotations.h.

◆ removeAnnotationsHandler()

void removeAnnotationsHandler ( )

Use this function to un-register the AnnotationsHandler.

Definition at line 131 of file annotations.h.

◆ requestAnnotations()

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 48 of file annotations.cpp.

◆ storeAnnotations()

void storeAnnotations ( const 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'.

aListA list of notes to store.

Definition at line 32 of file annotations.cpp.

The documentation for this class was generated from the following files: